/* * "$Id: http-private.h 7721 2008-07-11 22:48:49Z mike $" * * Private HTTP definitions for the Common UNIX Printing System (CUPS). * * Copyright 2007 by Apple Inc. * Copyright 1997-2007 by Easy Software Products, all rights reserved. * * These coded instructions, statements, and computer programs are the * property of Apple Inc. and are protected by Federal copyright * law. Distribution and use rights are outlined in the file "LICENSE.txt" * which should have been included with this file. If this file is * file is missing or damaged, see the license at "http://www.cups.org/". * * This file is subject to the Apple OS-Developed Software exception. */ #ifndef _CUPS_HTTP_PRIVATE_H_ # define _CUPS_HTTP_PRIVATE_H_ /* * Include necessary headers... */ # include <stdlib.h> # include <config.h> # ifdef __sun # include <sys/select.h> # endif /* __sun */ # include <limits.h> # ifdef WIN32 # include <io.h> # include <winsock2.h> # else # include <unistd.h> # include <fcntl.h> # include <sys/socket.h> # define closesocket(f) close(f) # endif /* WIN32 */ # ifdef HAVE_GSSAPI # ifdef HAVE_GSSAPI_GSSAPI_H # include <gssapi/gssapi.h> # endif /* HAVE_GSSAPI_GSSAPI_H */ # ifdef HAVE_GSSAPI_GSSAPI_GENERIC_H # include <gssapi/gssapi_generic.h> # endif /* HAVE_GSSAPI_GSSAPI_GENERIC_H */ # ifdef HAVE_GSSAPI_GSSAPI_KRB5_H # include <gssapi/gssapi_krb5.h> # endif /* HAVE_GSSAPI_GSSAPI_KRB5_H */ # ifdef HAVE_GSSAPI_H # include <gssapi.h> # endif /* HAVE_GSSAPI_H */ # ifndef HAVE_GSS_C_NT_HOSTBASED_SERVICE # define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name # endif /* !HAVE_GSS_C_NT_HOSTBASED_SERVICE */ # ifdef HAVE_KRB5_H # include <krb5.h> # endif /* HAVE_KRB5_H */ # endif /* HAVE_GSSAPI */ # ifdef HAVE_AUTHORIZATION_H # include <Security/Authorization.h> # endif /* HAVE_AUTHORIZATION_H */ # if defined(__sgi) || (defined(__APPLE__) && !defined(_SOCKLEN_T)) /* * IRIX and MacOS X 10.2.x do not define socklen_t, and in fact use an int instead of * unsigned type for length values... */ typedef int socklen_t; # endif /* __sgi || (__APPLE__ && !_SOCKLEN_T) */ # include "http.h" # include "md5.h" # include "ipp-private.h" # if defined HAVE_LIBSSL /* * The OpenSSL library provides its own SSL/TLS context structure for its * IO and protocol management. However, we need to provide our own BIO * (basic IO) implementation to do timeouts... */ # include <openssl/err.h> # include <openssl/rand.h> # include <openssl/ssl.h> typedef SSL http_tls_t; extern BIO_METHOD *_httpBIOMethods(void); # elif defined HAVE_GNUTLS /* * The GNU TLS library is more of a "bare metal" SSL/TLS library... */ # include <gnutls/gnutls.h> typedef struct { gnutls_session session; /* GNU TLS session object */ void *credentials; /* GNU TLS credentials object */ } http_tls_t; extern ssize_t _httpReadGNUTLS(gnutls_transport_ptr ptr, void *data, size_t length); extern ssize_t _httpWriteGNUTLS(gnutls_transport_ptr ptr, const void *data, size_t length); # elif defined(HAVE_CDSASSL) /* * Darwin's Security framework provides its own SSL/TLS context structure * for its IO and protocol management... */ # include <Security/SecureTransport.h> typedef struct /**** CDSA connection information ****/ { SSLContextRef session; /* CDSA session object */ CFArrayRef certsArray; /* Certificates array */ } http_tls_t; extern OSStatus _httpReadCDSA(SSLConnectionRef connection, void *data, size_t *dataLength); extern OSStatus _httpWriteCDSA(SSLConnectionRef connection, const void *data, size_t *dataLength); # endif /* HAVE_LIBSSL */ struct _http_s /**** HTTP connection structure. ****/ { int fd; /* File descriptor for this socket */ int blocking; /* To block or not to block */ int error; /* Last error on read */ time_t activity; /* Time since last read/write */ http_state_t state; /* State of client */ http_status_t status; /* Status of last request */ http_version_t version; /* Protocol version */ http_keepalive_t keep_alive; /* Keep-alive supported? */ struct sockaddr_in _hostaddr; /* Address of connected host @deprecated@ */ char hostname[HTTP_MAX_HOST], /* Name of connected host */ fields[HTTP_FIELD_MAX][HTTP_MAX_VALUE]; /* Field values */ char *data; /* Pointer to data buffer */ http_encoding_t data_encoding; /* Chunked or not */ int _data_remaining;/* Number of bytes left @deprecated@ */ int used; /* Number of bytes used in buffer */ char buffer[HTTP_MAX_BUFFER]; /* Buffer for incoming data */ int auth_type; /* Authentication in use */ _cups_md5_state_t md5_state; /* MD5 state */ char nonce[HTTP_MAX_VALUE]; /* Nonce value */ int nonce_count; /* Nonce count */ void *tls; /* TLS state information */ http_encryption_t encryption; /* Encryption requirements */ /**** New in CUPS 1.1.19 ****/ fd_set *input_set; /* select() set for httpWait() @deprecated@ */ http_status_t expect; /* Expect: header @since CUPS 1.1.19@ */ char *cookie; /* Cookie value(s) @since CUPS 1.1.19@ */ /**** New in CUPS 1.1.20 ****/ char _authstring[HTTP_MAX_VALUE], /* Current Authentication value. @deprecated@ */ userpass[HTTP_MAX_VALUE]; /* Username:password string @since CUPS 1.1.20@ */ int digest_tries; /* Number of tries for digest auth @since CUPS 1.1.20@ */ /**** New in CUPS 1.2 ****/ off_t data_remaining; /* Number of bytes left @since CUPS 1.2@ */ http_addr_t *hostaddr; /* Current host address and port @since CUPS 1.2@ */ http_addrlist_t *addrlist; /* List of valid addresses @since CUPS 1.2@ */ char wbuffer[HTTP_MAX_BUFFER]; /* Buffer for outgoing data */ int wused; /* Write buffer bytes used @since CUPS 1.2@ */ /**** New in CUPS 1.3 ****/ char *field_authorization; /* Authorization field @since CUPS 1.3@ */ char *authstring; /* Current authorization field @since CUPS 1.3 */ # ifdef HAVE_GSSAPI gss_OID gssmech; /* Authentication mechanism @since CUPS 1.3@ */ gss_ctx_id_t gssctx; /* Authentication context @since CUPS 1.3@ */ gss_name_t gssname; /* Authentication server name @since CUPS 1.3@ */ # endif /* HAVE_GSSAPI */ # ifdef HAVE_AUTHORIZATION_H AuthorizationRef auth_ref; /* Authorization ref */ # endif /* HAVE_AUTHORIZATION_H */ }; /* * Some OS's don't have hstrerror(), most notably Solaris... */ # ifndef HAVE_HSTRERROR extern const char *_cups_hstrerror(int error); # define hstrerror _cups_hstrerror # elif defined(_AIX) || defined(__osf__) /* * AIX and Tru64 UNIX don't provide a prototype but do provide the function... */ extern const char *hstrerror(int error); # endif /* !HAVE_HSTRERROR */ /* * Some OS's don't have getifaddrs() and freeifaddrs()... */ # ifndef WIN32 # include <net/if.h> # ifdef HAVE_GETIFADDRS # include <ifaddrs.h> # else # include <sys/ioctl.h> # ifdef HAVE_SYS_SOCKIO_H # include <sys/sockio.h> # endif /* HAVE_SYS_SOCKIO_H */ # ifdef ifa_dstaddr # undef ifa_dstaddr # endif /* ifa_dstaddr */ # ifndef ifr_netmask # define ifr_netmask ifr_addr # endif /* !ifr_netmask */ struct ifaddrs /**** Interface Structure ****/ { struct ifaddrs *ifa_next; /* Next interface in list */ char *ifa_name; /* Name of interface */ unsigned int ifa_flags; /* Flags (up, point-to-point, etc.) */ struct sockaddr *ifa_addr, /* Network address */ *ifa_netmask; /* Address mask */ union { struct sockaddr *ifu_broadaddr; /* Broadcast address of this interface. */ struct sockaddr *ifu_dstaddr; /* Point-to-point destination address. */ } ifa_ifu; void *ifa_data; /* Interface statistics */ }; # ifndef ifa_broadaddr # define ifa_broadaddr ifa_ifu.ifu_broadaddr # endif /* !ifa_broadaddr */ # ifndef ifa_dstaddr # define ifa_dstaddr ifa_ifu.ifu_dstaddr # endif /* !ifa_dstaddr */ extern int _cups_getifaddrs(struct ifaddrs **addrs); # define getifaddrs _cups_getifaddrs extern void _cups_freeifaddrs(struct ifaddrs *addrs); # define freeifaddrs _cups_freeifaddrs # endif /* HAVE_GETIFADDRS */ # endif /* !WIN32 */ /* * Common URI encoding function... */ extern char *_httpEncodeURI(char *dst, const char *src, size_t dstsize); #endif /* !_CUPS_HTTP_PRIVATE_H_ */ /* * End of "$Id: http-private.h 7721 2008-07-11 22:48:49Z mike $". */