[thirdparty/cups.git] / cups / http-private.h

/*
 * "$Id$"
 *
 * Private HTTP definitions for CUPS.
 *
 * Copyright 2007-2013 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 "config.h"
#  include <cups/language.h>
#  include <stddef.h>
#  include <stdlib.h>

#  ifdef __sun
#    include <sys/select.h>
#  endif /* __sun */

#  include <limits.h>
#  ifdef WIN32
#    include <io.h>
#    include <winsock2.h>
#    define CUPS_SOCAST (const char *)
#  else
#    include <unistd.h>
#    include <fcntl.h>
#    include <sys/socket.h>
#    define CUPS_SOCAST
#  endif /* WIN32 */

#  ifdef HAVE_GSSAPI
#    ifdef HAVE_GSS_GSSAPI_H
#      include <GSS/gssapi.h>
#    elif defined(HAVE_GSSAPI_GSSAPI_H)
#      include <gssapi/gssapi.h>
#    elif defined(HAVE_GSSAPI_H)
#      include <gssapi.h>
#    endif /* HAVE_GSS_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 */
#  endif /* HAVE_GSSAPI */

#  ifdef HAVE_AUTHORIZATION_H
#    include <Security/Authorization.h>
#  endif /* HAVE_AUTHORIZATION_H */

#  if defined(__APPLE__) && !defined(_SOCKLEN_T)
/*
 * MacOS X 10.2.x does not define socklen_t, and in fact uses an int instead of
 * unsigned type for length values...
 */

typedef int socklen_t;
#  endif /* __APPLE__ && !_SOCKLEN_T */

#  include <cups/http.h>
#  include "md5-private.h"
#  include "ipp-private.h"

#  if defined HAVE_LIBSSL
#    include <openssl/err.h>
#    include <openssl/rand.h>
#    include <openssl/ssl.h>
#  elif defined HAVE_GNUTLS
#    include <gnutls/gnutls.h>
#    include <gnutls/x509.h>
#    include <gcrypt.h>
#  elif defined(HAVE_CDSASSL)
#    include <CoreFoundation/CoreFoundation.h>
#    include <Security/Security.h>
#    include <Security/SecureTransport.h>
#    ifdef HAVE_SECURETRANSPORTPRIV_H
#      include <Security/SecureTransportPriv.h>
#    endif /* HAVE_SECURETRANSPORTPRIV_H */
#    ifdef HAVE_SECITEM_H
#      include <Security/SecItem.h>
#    endif /* HAVE_SECITEM_H */
#    ifdef HAVE_SECBASEPRIV_H
#      include <Security/SecBasePriv.h>
#    endif /* HAVE_SECBASEPRIV_H */
#    ifdef HAVE_SECCERTIFICATE_H
#      include <Security/SecCertificate.h>
#      include <Security/SecIdentity.h>
#    endif /* HAVE_SECCERTIFICATE_H */
#    ifdef HAVE_SECITEMPRIV_H
#      include <Security/SecItemPriv.h>
#    endif /* HAVE_SECITEMPRIV_H */
#    ifdef HAVE_SECIDENTITYSEARCHPRIV_H
#      include <Security/SecIdentitySearchPriv.h>
#    endif /* HAVE_SECIDENTITYSEARCHPRIV_H */
#    ifdef HAVE_SECPOLICYPRIV_H
#      include <Security/SecPolicyPriv.h>
#    endif /* HAVE_SECPOLICYPRIV_H */
#  elif defined(HAVE_SSPISSL)
#    include "sspi-private.h"
#  endif /* HAVE_LIBSSL */

#  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 */
#    endif /* HAVE_GETIFADDRS */
#  endif /* !WIN32 */

#  ifdef HAVE_LIBZ
#    include <zlib.h>
#  endif /* HAVE_LIBZ */


/*
 * C++ magic...
 */

#  ifdef __cplusplus
extern "C" {
#  endif /* __cplusplus */


/*
 * Constants...
 */


#define _HTTP_RESOLVE_DEFAULT	0	/* Just resolve with default options */
#define _HTTP_RESOLVE_STDERR	1	/* Log resolve progress to stderr */
#define _HTTP_RESOLVE_FQDN	2	/* Resolve to a FQDN */
#define _HTTP_RESOLVE_FAXOUT	4	/* Resolve FaxOut service? */


/*
 * Types and functions for SSL support...
 */

#  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...
 */

typedef SSL  *http_tls_t;
typedef void *http_tls_credentials_t;

//extern BIO_METHOD *_httpBIOMethods(void);

#  elif defined HAVE_GNUTLS
/*
 * The GNU TLS library is more of a "bare metal" SSL/TLS library...
 */

typedef gnutls_session http_tls_t;
typedef void *http_tls_credentials_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...
 */

#    if !defined(HAVE_SECBASEPRIV_H) && defined(HAVE_CSSMERRORSTRING) /* Declare prototype for function in that header... */
extern const char *cssmErrorString(int error);
#    endif /* !HAVE_SECBASEPRIV_H && HAVE_CSSMERRORSTRING */
#    ifndef HAVE_SECITEMPRIV_H /* Declare constants from that header... */
extern const CFTypeRef kSecClassCertificate;
extern const CFTypeRef kSecClassIdentity;
#    endif /* !HAVE_SECITEMPRIV_H */
#    if !defined(HAVE_SECIDENTITYSEARCHPRIV_H) && defined(HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY) /* Declare prototype for function in that header... */
extern OSStatus SecIdentitySearchCreateWithPolicy(SecPolicyRef policy,
				CFStringRef idString, CSSM_KEYUSE keyUsage,
				CFTypeRef keychainOrArray,
				Boolean returnOnlyValidIdentities,
				SecIdentitySearchRef* searchRef);
#    endif /* !HAVE_SECIDENTITYSEARCHPRIV_H && HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY */
#    if !defined(HAVE_SECPOLICYPRIV_H) && defined(HAVE_SECPOLICYSETVALUE) /* Declare prototype for function in that header... */
extern OSStatus SecPolicySetValue(SecPolicyRef policyRef,
                                  const CSSM_DATA *value);
#    endif /* !HAVE_SECPOLICYPRIV_H && HAVE_SECPOLICYSETVALUE */

typedef SSLContextRef	http_tls_t;
typedef CFArrayRef	http_tls_credentials_t;

#  elif defined(HAVE_SSPISSL)
/*
 * Windows' SSPI library gets a CUPS wrapper...
 */

typedef _sspi_struct_t * http_tls_t;
typedef void *http_tls_credentials_t;

#  else
/*
 * Otherwise define stub types since we have no SSL support...
 */

typedef void *http_tls_t;
typedef void *http_tls_credentials_t;
#  endif /* HAVE_LIBSSL */

typedef enum _http_coding_e		/**** HTTP content coding enumeration ****/
{
  _HTTP_CODING_IDENTITY,		/* No content coding */
  _HTTP_CODING_GZIP,			/* LZ77+gzip decompression */
  _HTTP_CODING_DEFLATE,			/* LZ77+zlib compression */
  _HTTP_CODING_GUNZIP,			/* LZ77+gzip decompression */
  _HTTP_CODING_INFLATE			/* LZ77+zlib decompression */
} _http_coding_t;

typedef enum _http_mode_e		/**** HTTP mode enumeration ****/
{
  _HTTP_MODE_CLIENT,			/* Client connected to server */
  _HTTP_MODE_SERVER			/* Server connected (accepted) from client */
} _http_mode_t;

#  ifndef _HTTP_NO_PRIVATE
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_ACCEPT_ENCODING][HTTP_MAX_VALUE];
					/* Field values up to Accept-Encoding */
  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 (deprecated) */
  _cups_md5_state_t	md5_state;	/* MD5 state */
  char			nonce[HTTP_MAX_VALUE];
					/* Nonce value */
  int			nonce_count;	/* Nonce count */
  http_tls_t		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 */
  char			*cookie;	/* Cookie value(s) */

  /**** New in CUPS 1.1.20 ****/
  char			_authstring[HTTP_MAX_VALUE],
					/* Current Authorization value (deprecated) */
			userpass[HTTP_MAX_VALUE];
					/* Username:password string */
  int			digest_tries;	/* Number of tries for digest auth */

  /**** New in CUPS 1.2 ****/
  off_t			data_remaining;	/* Number of bytes left */
  http_addr_t		*hostaddr;	/* Current host address and port */
  http_addrlist_t	*addrlist;	/* List of valid addresses */
  char			wbuffer[HTTP_MAX_BUFFER];
					/* Buffer for outgoing data */
  int			wused;		/* Write buffer bytes used */

  /**** New in CUPS 1.3 ****/
  char			*field_authorization;
					/* Authorization field */
  char			*authstring;	/* Current Authorization field */
#  ifdef HAVE_GSSAPI
  gss_OID 		gssmech;	/* Authentication mechanism */
  gss_ctx_id_t		gssctx;		/* Authentication context */
  gss_name_t		gssname;	/* Authentication server name */
#  endif /* HAVE_GSSAPI */
#  ifdef HAVE_AUTHORIZATION_H
  AuthorizationRef	auth_ref;	/* Authorization ref */
#  endif /* HAVE_AUTHORIZATION_H */

  /**** New in CUPS 1.5 ****/
  http_tls_credentials_t tls_credentials;
					/* TLS credentials */
  http_timeout_cb_t	timeout_cb;	/* Timeout callback */
  void			*timeout_data;	/* User data pointer */
  double		timeout_value;	/* Timeout in seconds */
  int			wait_value;	/* httpWait value for timeout */
#  ifdef HAVE_GSSAPI
  char			gsshost[256];	/* Hostname for Kerberos */
#  endif /* HAVE_GSSAPI */

  /**** New in CUPS 1.7 ****/
  int			tls_upgrade;	/* Non-zero if we are doing an upgrade */
  _http_mode_t		mode;		/* _HTTP_MODE_CLIENT or _HTTP_MODE_SERVER */
  char			*accept_encoding,
					/* Accept-Encoding field */
			*allow,		/* Allow field */
			*server,	/* Server field */
			*default_accept_encoding,
			*default_server,
			*default_user_agent;
					/* Default field values */
#  ifdef HAVE_LIBZ
  _http_coding_t	coding;		/* _HTTP_CODING_xxx */
  z_stream		stream;		/* (De)compression stream */
  Bytef			*dbuffer;	/* Decompression buffer */
#  endif /* HAVE_LIBZ */
};
#  endif /* !_HTTP_NO_PRIVATE */


/*
 * 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()...
 */

#  if !defined(WIN32) && !defined(HAVE_GETIFADDRS)
#    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 /* !WIN32 && !HAVE_GETIFADDRS */


/*
 * Prototypes...
 */

extern void		_httpAddrSetPort(http_addr_t *addr, int port);
extern http_tls_credentials_t
			_httpCreateCredentials(cups_array_t *credentials);
extern char		*_httpDecodeURI(char *dst, const char *src,
			                size_t dstsize);
extern void		_httpDisconnect(http_t *http);
extern char		*_httpEncodeURI(char *dst, const char *src,
			                size_t dstsize);
extern void		_httpFreeCredentials(http_tls_credentials_t credentials);
extern const char	*_httpResolveURI(const char *uri, char *resolved_uri,
			                 size_t resolved_size, int options,
					 int (*cb)(void *context),
					 void *context);
extern const char	*_httpStatus(cups_lang_t *lang, http_status_t status);
extern int		_httpUpdate(http_t *http, http_status_t *status);
extern int		_httpWait(http_t *http, int msec, int usessl);


/*
 * C++ magic...
 */

#  ifdef __cplusplus
}
#  endif /* __cplusplus */

#endif /* !_CUPS_HTTP_PRIVATE_H_ */

/*
 * End of "$Id$".
 */
Commit	Line	Data
	1	/*
	2	* "$Id$"
	3	*
	4	* Private HTTP definitions for CUPS.
	5	*
	6	* Copyright 2007-2013 by Apple Inc.
	7	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
	8	*
	9	* These coded instructions, statements, and computer programs are the
	10	* property of Apple Inc. and are protected by Federal copyright
	11	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	12	* which should have been included with this file. If this file is
	13	* file is missing or damaged, see the license at "http://www.cups.org/".
	14	*
	15	* This file is subject to the Apple OS-Developed Software exception.
	16	*/
	17
	18	#ifndef _CUPS_HTTP_PRIVATE_H_
	19	# define _CUPS_HTTP_PRIVATE_H_
	20
	21	/*
	22	* Include necessary headers...
	23	*/
	24
	25	# include "config.h"
	26	# include <cups/language.h>
	27	# include <stddef.h>
	28	# include <stdlib.h>
	29
	30	# ifdef __sun
	31	# include <sys/select.h>
	32	# endif /* __sun */
	33
	34	# include <limits.h>
	35	# ifdef WIN32
	36	# include <io.h>
	37	# include <winsock2.h>
	38	# define CUPS_SOCAST (const char *)
	39	# else
	40	# include <unistd.h>
	41	# include <fcntl.h>
	42	# include <sys/socket.h>
	43	# define CUPS_SOCAST
	44	# endif /* WIN32 */
	45
	46	# ifdef HAVE_GSSAPI
	47	# ifdef HAVE_GSS_GSSAPI_H
	48	# include <GSS/gssapi.h>
	49	# elif defined(HAVE_GSSAPI_GSSAPI_H)
	50	# include <gssapi/gssapi.h>
	51	# elif defined(HAVE_GSSAPI_H)
	52	# include <gssapi.h>
	53	# endif /* HAVE_GSS_GSSAPI_H */
	54	# ifndef HAVE_GSS_C_NT_HOSTBASED_SERVICE
	55	# define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
	56	# endif /* !HAVE_GSS_C_NT_HOSTBASED_SERVICE */
	57	# endif /* HAVE_GSSAPI */
	58
	59	# ifdef HAVE_AUTHORIZATION_H
	60	# include <Security/Authorization.h>
	61	# endif /* HAVE_AUTHORIZATION_H */
	62
	63	# if defined(__APPLE__) && !defined(_SOCKLEN_T)
	64	/*
	65	* MacOS X 10.2.x does not define socklen_t, and in fact uses an int instead of
	66	* unsigned type for length values...
	67	*/
	68
	69	typedef int socklen_t;
	70	# endif /* __APPLE__ && !_SOCKLEN_T */
	71
	72	# include <cups/http.h>
	73	# include "md5-private.h"
	74	# include "ipp-private.h"
	75
	76	# if defined HAVE_LIBSSL
	77	# include <openssl/err.h>
	78	# include <openssl/rand.h>
	79	# include <openssl/ssl.h>
	80	# elif defined HAVE_GNUTLS
	81	# include <gnutls/gnutls.h>
	82	# include <gnutls/x509.h>
	83	# include <gcrypt.h>
	84	# elif defined(HAVE_CDSASSL)
	85	# include <CoreFoundation/CoreFoundation.h>
	86	# include <Security/Security.h>
	87	# include <Security/SecureTransport.h>
	88	# ifdef HAVE_SECURETRANSPORTPRIV_H
	89	# include <Security/SecureTransportPriv.h>
	90	# endif /* HAVE_SECURETRANSPORTPRIV_H */
	91	# ifdef HAVE_SECITEM_H
	92	# include <Security/SecItem.h>
	93	# endif /* HAVE_SECITEM_H */
	94	# ifdef HAVE_SECBASEPRIV_H
	95	# include <Security/SecBasePriv.h>
	96	# endif /* HAVE_SECBASEPRIV_H */
	97	# ifdef HAVE_SECCERTIFICATE_H
	98	# include <Security/SecCertificate.h>
	99	# include <Security/SecIdentity.h>
	100	# endif /* HAVE_SECCERTIFICATE_H */
	101	# ifdef HAVE_SECITEMPRIV_H
	102	# include <Security/SecItemPriv.h>
	103	# endif /* HAVE_SECITEMPRIV_H */
	104	# ifdef HAVE_SECIDENTITYSEARCHPRIV_H
	105	# include <Security/SecIdentitySearchPriv.h>
	106	# endif /* HAVE_SECIDENTITYSEARCHPRIV_H */
	107	# ifdef HAVE_SECPOLICYPRIV_H
	108	# include <Security/SecPolicyPriv.h>
	109	# endif /* HAVE_SECPOLICYPRIV_H */
	110	# elif defined(HAVE_SSPISSL)
	111	# include "sspi-private.h"
	112	# endif /* HAVE_LIBSSL */
	113
	114	# ifndef WIN32
	115	# include <net/if.h>
	116	# ifdef HAVE_GETIFADDRS
	117	# include <ifaddrs.h>
	118	# else
	119	# include <sys/ioctl.h>
	120	# ifdef HAVE_SYS_SOCKIO_H
	121	# include <sys/sockio.h>
	122	# endif /* HAVE_SYS_SOCKIO_H */
	123	# endif /* HAVE_GETIFADDRS */
	124	# endif /* !WIN32 */
	125
	126	# ifdef HAVE_LIBZ
	127	# include <zlib.h>
	128	# endif /* HAVE_LIBZ */
	129
	130
	131	/*
	132	* C++ magic...
	133	*/
	134
	135	# ifdef __cplusplus
	136	extern "C" {
	137	# endif /* __cplusplus */
	138
	139
	140	/*
	141	* Constants...
	142	*/
	143
	144
	145	#define _HTTP_RESOLVE_DEFAULT 0 /* Just resolve with default options */
	146	#define _HTTP_RESOLVE_STDERR 1 /* Log resolve progress to stderr */
	147	#define _HTTP_RESOLVE_FQDN 2 /* Resolve to a FQDN */
	148	#define _HTTP_RESOLVE_FAXOUT 4 /* Resolve FaxOut service? */
	149
	150
	151	/*
	152	* Types and functions for SSL support...
	153	*/
	154
	155	# if defined HAVE_LIBSSL
	156	/*
	157	* The OpenSSL library provides its own SSL/TLS context structure for its
	158	* IO and protocol management. However, we need to provide our own BIO
	159	* (basic IO) implementation to do timeouts...
	160	*/
	161
	162	typedef SSL *http_tls_t;
	163	typedef void *http_tls_credentials_t;
	164
	165	//extern BIO_METHOD *_httpBIOMethods(void);
	166
	167	# elif defined HAVE_GNUTLS
	168	/*
	169	* The GNU TLS library is more of a "bare metal" SSL/TLS library...
	170	*/
	171
	172	typedef gnutls_session http_tls_t;
	173	typedef void *http_tls_credentials_t;
	174
	175	//extern ssize_t _httpReadGNUTLS(gnutls_transport_ptr ptr, void *data,
	176	// size_t length);
	177	//extern ssize_t _httpWriteGNUTLS(gnutls_transport_ptr ptr, const void *data,
	178	// size_t length);
	179
	180	# elif defined(HAVE_CDSASSL)
	181	/*
	182	* Darwin's Security framework provides its own SSL/TLS context structure
	183	* for its IO and protocol management...
	184	*/
	185
	186	# if !defined(HAVE_SECBASEPRIV_H) && defined(HAVE_CSSMERRORSTRING) /* Declare prototype for function in that header... */
	187	extern const char *cssmErrorString(int error);
	188	# endif /* !HAVE_SECBASEPRIV_H && HAVE_CSSMERRORSTRING */
	189	# ifndef HAVE_SECITEMPRIV_H /* Declare constants from that header... */
	190	extern const CFTypeRef kSecClassCertificate;
	191	extern const CFTypeRef kSecClassIdentity;
	192	# endif /* !HAVE_SECITEMPRIV_H */
	193	# if !defined(HAVE_SECIDENTITYSEARCHPRIV_H) && defined(HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY) /* Declare prototype for function in that header... */
	194	extern OSStatus SecIdentitySearchCreateWithPolicy(SecPolicyRef policy,
	195	CFStringRef idString, CSSM_KEYUSE keyUsage,
	196	CFTypeRef keychainOrArray,
	197	Boolean returnOnlyValidIdentities,
	198	SecIdentitySearchRef* searchRef);
	199	# endif /* !HAVE_SECIDENTITYSEARCHPRIV_H && HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY */
	200	# if !defined(HAVE_SECPOLICYPRIV_H) && defined(HAVE_SECPOLICYSETVALUE) /* Declare prototype for function in that header... */
	201	extern OSStatus SecPolicySetValue(SecPolicyRef policyRef,
	202	const CSSM_DATA *value);
	203	# endif /* !HAVE_SECPOLICYPRIV_H && HAVE_SECPOLICYSETVALUE */
	204
	205	typedef SSLContextRef http_tls_t;
	206	typedef CFArrayRef http_tls_credentials_t;
	207
	208	# elif defined(HAVE_SSPISSL)
	209	/*
	210	* Windows' SSPI library gets a CUPS wrapper...
	211	*/
	212
	213	typedef _sspi_struct_t * http_tls_t;
	214	typedef void *http_tls_credentials_t;
	215
	216	# else
	217	/*
	218	* Otherwise define stub types since we have no SSL support...
	219	*/
	220
	221	typedef void *http_tls_t;
	222	typedef void *http_tls_credentials_t;
	223	# endif /* HAVE_LIBSSL */
	224
	225	typedef enum _http_coding_e /** HTTP content coding enumeration **/
	226	{
	227	_HTTP_CODING_IDENTITY, /* No content coding */
	228	_HTTP_CODING_GZIP, /* LZ77+gzip decompression */
	229	_HTTP_CODING_DEFLATE, /* LZ77+zlib compression */
	230	_HTTP_CODING_GUNZIP, /* LZ77+gzip decompression */
	231	_HTTP_CODING_INFLATE /* LZ77+zlib decompression */
	232	} _http_coding_t;
	233
	234	typedef enum _http_mode_e /** HTTP mode enumeration **/
	235	{
	236	_HTTP_MODE_CLIENT, /* Client connected to server */
	237	_HTTP_MODE_SERVER /* Server connected (accepted) from client */
	238	} _http_mode_t;
	239
	240	# ifndef _HTTP_NO_PRIVATE
	241	struct _http_s /** HTTP connection structure **/
	242	{
	243	int fd; /* File descriptor for this socket */
	244	int blocking; /* To block or not to block */
	245	int error; /* Last error on read */
	246	time_t activity; /* Time since last read/write */
	247	http_state_t state; /* State of client */
	248	http_status_t status; /* Status of last request */
	249	http_version_t version; /* Protocol version */
	250	http_keepalive_t keep_alive; /* Keep-alive supported? */
	251	struct sockaddr_in _hostaddr; /* Address of connected host (deprecated) */
	252	char hostname[HTTP_MAX_HOST],
	253	/* Name of connected host */
	254	fields[HTTP_FIELD_ACCEPT_ENCODING][HTTP_MAX_VALUE];
	255	/* Field values up to Accept-Encoding */
	256	char data; / Pointer to data buffer */
	257	http_encoding_t data_encoding; /* Chunked or not */
	258	int _data_remaining;/* Number of bytes left (deprecated) */
	259	int used; /* Number of bytes used in buffer */
	260	char buffer[HTTP_MAX_BUFFER];
	261	/* Buffer for incoming data */
	262	int _auth_type; /* Authentication in use (deprecated) */
	263	_cups_md5_state_t md5_state; /* MD5 state */
	264	char nonce[HTTP_MAX_VALUE];
	265	/* Nonce value */
	266	int nonce_count; /* Nonce count */
	267	http_tls_t tls; /* TLS state information */
	268	http_encryption_t encryption; /* Encryption requirements */
	269
	270	/** New in CUPS 1.1.19 **/
	271	fd_set input_set; / select() set for httpWait() (deprecated) */
	272	http_status_t expect; /* Expect: header */
	273	char cookie; / Cookie value(s) */
	274
	275	/** New in CUPS 1.1.20 **/
	276	char _authstring[HTTP_MAX_VALUE],
	277	/* Current Authorization value (deprecated) */
	278	userpass[HTTP_MAX_VALUE];
	279	/* Username:password string */
	280	int digest_tries; /* Number of tries for digest auth */
	281
	282	/** New in CUPS 1.2 **/
	283	off_t data_remaining; /* Number of bytes left */
	284	http_addr_t hostaddr; / Current host address and port */
	285	http_addrlist_t addrlist; / List of valid addresses */
	286	char wbuffer[HTTP_MAX_BUFFER];
	287	/* Buffer for outgoing data */
	288	int wused; /* Write buffer bytes used */
	289
	290	/** New in CUPS 1.3 **/
	291	char *field_authorization;
	292	/* Authorization field */
	293	char authstring; / Current Authorization field */
	294	# ifdef HAVE_GSSAPI
	295	gss_OID gssmech; /* Authentication mechanism */
	296	gss_ctx_id_t gssctx; /* Authentication context */
	297	gss_name_t gssname; /* Authentication server name */
	298	# endif /* HAVE_GSSAPI */
	299	# ifdef HAVE_AUTHORIZATION_H
	300	AuthorizationRef auth_ref; /* Authorization ref */
	301	# endif /* HAVE_AUTHORIZATION_H */
	302
	303	/** New in CUPS 1.5 **/
	304	http_tls_credentials_t tls_credentials;
	305	/* TLS credentials */
	306	http_timeout_cb_t timeout_cb; /* Timeout callback */
	307	void timeout_data; / User data pointer */
	308	double timeout_value; /* Timeout in seconds */
	309	int wait_value; /* httpWait value for timeout */
	310	# ifdef HAVE_GSSAPI
	311	char gsshost[256]; /* Hostname for Kerberos */
	312	# endif /* HAVE_GSSAPI */
	313
	314	/** New in CUPS 1.7 **/
	315	int tls_upgrade; /* Non-zero if we are doing an upgrade */
	316	_http_mode_t mode; /* _HTTP_MODE_CLIENT or _HTTP_MODE_SERVER */
	317	char *accept_encoding,
	318	/* Accept-Encoding field */
	319	allow, / Allow field */
	320	server, / Server field */
	321	*default_accept_encoding,
	322	*default_server,
	323	*default_user_agent;
	324	/* Default field values */
	325	# ifdef HAVE_LIBZ
	326	_http_coding_t coding; /* _HTTP_CODING_xxx */
	327	z_stream stream; /* (De)compression stream */
	328	Bytef dbuffer; / Decompression buffer */
	329	# endif /* HAVE_LIBZ */
	330	};
	331	# endif /* !_HTTP_NO_PRIVATE */
	332
	333
	334	/*
	335	* Some OS's don't have hstrerror(), most notably Solaris...
	336	*/
	337
	338	# ifndef HAVE_HSTRERROR
	339	extern const char *_cups_hstrerror(int error);
	340	# define hstrerror _cups_hstrerror
	341	# elif defined(_AIX) \|\| defined(__osf__)
	342	/*
	343	* AIX and Tru64 UNIX don't provide a prototype but do provide the function...
	344	*/
	345	extern const char *hstrerror(int error);
	346	# endif /* !HAVE_HSTRERROR */
	347
	348
	349	/*
	350	* Some OS's don't have getifaddrs() and freeifaddrs()...
	351	*/
	352
	353	# if !defined(WIN32) && !defined(HAVE_GETIFADDRS)
	354	# ifdef ifa_dstaddr
	355	# undef ifa_dstaddr
	356	# endif /* ifa_dstaddr */
	357	# ifndef ifr_netmask
	358	# define ifr_netmask ifr_addr
	359	# endif /* !ifr_netmask */
	360
	361	struct ifaddrs /** Interface Structure **/
	362	{
	363	struct ifaddrs ifa_next; / Next interface in list */
	364	char ifa_name; / Name of interface */
	365	unsigned int ifa_flags; /* Flags (up, point-to-point, etc.) */
	366	struct sockaddr ifa_addr, / Network address */
	367	ifa_netmask; / Address mask */
	368	union
	369	{
	370	struct sockaddr ifu_broadaddr; / Broadcast address of this interface. */
	371	struct sockaddr ifu_dstaddr; / Point-to-point destination address. */
	372	} ifa_ifu;
	373
	374	void ifa_data; / Interface statistics */
	375	};
	376
	377	# ifndef ifa_broadaddr
	378	# define ifa_broadaddr ifa_ifu.ifu_broadaddr
	379	# endif /* !ifa_broadaddr */
	380	# ifndef ifa_dstaddr
	381	# define ifa_dstaddr ifa_ifu.ifu_dstaddr
	382	# endif /* !ifa_dstaddr */
	383
	384	extern int _cups_getifaddrs(struct ifaddrs **addrs);
	385	# define getifaddrs _cups_getifaddrs
	386	extern void _cups_freeifaddrs(struct ifaddrs *addrs);
	387	# define freeifaddrs _cups_freeifaddrs
	388	# endif /* !WIN32 && !HAVE_GETIFADDRS */
	389
	390
	391	/*
	392	* Prototypes...
	393	*/
	394
	395	extern void _httpAddrSetPort(http_addr_t *addr, int port);
	396	extern http_tls_credentials_t
	397	_httpCreateCredentials(cups_array_t *credentials);
	398	extern char _httpDecodeURI(char dst, const char *src,
	399	size_t dstsize);
	400	extern void _httpDisconnect(http_t *http);
	401	extern char _httpEncodeURI(char dst, const char *src,
	402	size_t dstsize);
	403	extern void _httpFreeCredentials(http_tls_credentials_t credentials);
	404	extern const char _httpResolveURI(const char uri, char *resolved_uri,
	405	size_t resolved_size, int options,
	406	int (cb)(void context),
	407	void *context);
	408	extern const char _httpStatus(cups_lang_t lang, http_status_t status);
	409	extern int _httpUpdate(http_t http, http_status_t status);
	410	extern int _httpWait(http_t *http, int msec, int usessl);
	411
	412
	413	/*
	414	* C++ magic...
	415	*/
	416
	417	# ifdef __cplusplus
	418	}
	419	# endif /* __cplusplus */
	420
	421	#endif /* !_CUPS_HTTP_PRIVATE_H_ */
	422
	423	/*
	424	* End of "$Id$".
	425	*/