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

/*
 * "$Id$"
 *
 *   Private HTTP definitions for CUPS.
 *
 *   Copyright 2007-2012 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 <stddef.h>
#  include <stdlib.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_GSS_GSSAPI_H
#      include <GSS/gssapi.h>
#      ifdef HAVE_GSSAPI_GENERIC_H
#        include <GSS/gssapi_generic.h>
#      endif /* HAVE_GSSAPI_GENERIC_H */
#      ifdef HAVE_GSSAPI_KRB5_H
#        include <GSS/gssapi_krb5.h>
#      endif /* HAVE_GSSAPI_KRB5_H */
#    elif defined(HAVE_GSSAPI_GSSAPI_H)
#      include <gssapi/gssapi.h>
#      ifdef HAVE_GSSAPI_GENERIC_H
#        include <gssapi/gssapi_generic.h>
#      endif /* HAVE_GSSAPI_GENERIC_H */
#      ifdef HAVE_GSSAPI_KRB5_H
#        include <gssapi/gssapi_krb5.h>
#      endif /* HAVE_GSSAPI_KRB5_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 */
#    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(__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;

extern OSStatus	_httpReadCDSA(SSLConnectionRef connection, void *data,
		              size_t *dataLength);
extern OSStatus	_httpWriteCDSA(SSLConnectionRef connection, const void *data,
		               size_t *dataLength);

#  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;

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 */
  _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 Authentication 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 ****/
  _http_mode_t		mode;		/* _HTTP_MODE_CLIENT or _HTTP_MODE_SERVER */
  char			*accept_encoding,
					/* Accept-Encoding field */
			*allow,		/* Allow field */
			*server;	/* Server field */
#  ifdef HAVE_LIBZ
  _http_coding_t	coding;		/* _HTTP_CODING_xxx */
  z_stream		stream;		/* (De)compression stream */
#  endif /* HAVE_LIBZ */
};


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

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