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

/*
 * "$Id: http-private.h 7850 2008-08-20 00:07:25Z mike $"
 *
 *   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 */


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

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 */
  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 */
};


/*
 * 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 int		_httpAddrPort(http_addr_t *addr);
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,
				     http_encryption_t encryption,
				     int family);
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 ssize_t		_httpPeek(http_t *http, char *buffer, size_t length);
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: http-private.h 7850 2008-08-20 00:07:25Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
b19ccc9e	2	* "$Id: http-private.h 7850 2008-08-20 00:07:25Z mike $"
ef416fc2	3	*
71e16022	4	* Private HTTP definitions for CUPS.
ef416fc2	5	*
f3c17241	6	* Copyright 2007-2012 by Apple Inc.
b86bc4cf	7	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2	8	*
ef416fc2	9	* These coded instructions, statements, and computer programs are the
bc44d920	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/".
ef416fc2	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
71e16022	25	# include "config.h"
5180a04c	26	# include <stddef.h>
a74454a7	27	# include <stdlib.h>
ef416fc2	28
ef416fc2	29	# ifdef __sun
ef416fc2	30	# include <sys/select.h>
	31	# endif /* __sun */
	32
	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
f7deaa1a	44	# ifdef HAVE_GSSAPI
eac3a0a0 MS	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)
f7deaa1a	54	# include <gssapi/gssapi.h>
eac3a0a0 MS	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)
f7deaa1a	62	# include <gssapi.h>
eac3a0a0	63	# endif /* HAVE_GSS_GSSAPI_H */
f7deaa1a	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 */
db1f069b MS	67	# ifdef HAVE_KRB5_H
	68	# include <krb5.h>
	69	# endif /* HAVE_KRB5_H */
f7deaa1a	70	# endif /* HAVE_GSSAPI */
f7deaa1a	71
b94498cf	72	# ifdef HAVE_AUTHORIZATION_H
	73	# include <Security/Authorization.h>
	74	# endif /* HAVE_AUTHORIZATION_H */
	75
3dd9c340	76	# if defined(__APPLE__) && !defined(_SOCKLEN_T)
ef416fc2	77	/*
3dd9c340	78	* MacOS X 10.2.x does not define socklen_t, and in fact uses an int instead of
ef416fc2	79	* unsigned type for length values...
	80	*/
	81
	82	typedef int socklen_t;
3dd9c340	83	# endif /* __APPLE__ && !_SOCKLEN_T */
ef416fc2	84
71e16022 MS	85	# include <cups/http.h>
71e16022 MS	86	# include "md5-private.h"
fa73b229	87	# include "ipp-private.h"
ef416fc2	88
07ed0e9a MS	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>
eac3a0a0 MS	101	# ifdef HAVE_SECURETRANSPORTPRIV_H
	102	# include <Security/SecureTransportPriv.h>
	103	# endif /* HAVE_SECURETRANSPORTPRIV_H */
07ed0e9a MS	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
	139
	140	/*
	141	* C++ magic...
	142	*/
	143
	144	# ifdef __cplusplus
	145	extern "C" {
	146	# endif /* __cplusplus */
	147
	148
eac3a0a0 MS	149	/*
	150	* Constants...
	151	*/
	152
	153
	154	#define _HTTP_RESOLVE_DEFAULT 0 /* Just resolve with default options */
	155	#define _HTTP_RESOLVE_STDERR 1 /* Log resolve progress to stderr */
	156	#define _HTTP_RESOLVE_FQDN 2 /* Resolve to a FQDN */
f3c17241	157	#define _HTTP_RESOLVE_FAXOUT 4 /* Resolve FaxOut service? */
eac3a0a0 MS	158
eac3a0a0 MS	159
07ed0e9a MS	160	/*
	161	* Types and functions for SSL support...
	162	*/
	163
ef416fc2	164	# if defined HAVE_LIBSSL
	165	/*
	166	* The OpenSSL library provides its own SSL/TLS context structure for its
411affcf	167	* IO and protocol management. However, we need to provide our own BIO
411affcf	168	* (basic IO) implementation to do timeouts...
ef416fc2	169	*/
ef416fc2	170
7cf5915e MS	171	typedef SSL *http_tls_t;
7cf5915e MS	172	typedef void *http_tls_credentials_t;
ef416fc2	173
411affcf	174	extern BIO_METHOD *_httpBIOMethods(void);
411affcf	175
ef416fc2	176	# elif defined HAVE_GNUTLS
	177	/*
	178	* The GNU TLS library is more of a "bare metal" SSL/TLS library...
	179	*/
ef416fc2	180
7cf5915e MS	181	typedef gnutls_session http_tls_t;
7cf5915e MS	182	typedef void *http_tls_credentials_t;
ef416fc2	183
411affcf	184	extern ssize_t _httpReadGNUTLS(gnutls_transport_ptr ptr, void *data,
	185	size_t length);
	186	extern ssize_t _httpWriteGNUTLS(gnutls_transport_ptr ptr, const void *data,
	187	size_t length);
	188
ef416fc2	189	# elif defined(HAVE_CDSASSL)
	190	/*
	191	* Darwin's Security framework provides its own SSL/TLS context structure
	192	* for its IO and protocol management...
	193	*/
	194
07ed0e9a	195	# if !defined(HAVE_SECBASEPRIV_H) && defined(HAVE_CSSMERRORSTRING) /* Declare prototype for function in that header... */
7cf5915e	196	extern const char *cssmErrorString(int error);
07ed0e9a MS	197	# endif /* !HAVE_SECBASEPRIV_H && HAVE_CSSMERRORSTRING */
07ed0e9a MS	198	# ifndef HAVE_SECITEMPRIV_H /* Declare constants from that header... */
7cf5915e MS	199	extern const CFTypeRef kSecClassCertificate;
7cf5915e MS	200	extern const CFTypeRef kSecClassIdentity;
07ed0e9a MS	201	# endif /* !HAVE_SECITEMPRIV_H */
07ed0e9a MS	202	# if !defined(HAVE_SECIDENTITYSEARCHPRIV_H) && defined(HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY) /* Declare prototype for function in that header... */
7cf5915e MS	203	extern OSStatus SecIdentitySearchCreateWithPolicy(SecPolicyRef policy,
	204	CFStringRef idString, CSSM_KEYUSE keyUsage,
	205	CFTypeRef keychainOrArray,
	206	Boolean returnOnlyValidIdentities,
	207	SecIdentitySearchRef* searchRef);
07ed0e9a MS	208	# endif /* !HAVE_SECIDENTITYSEARCHPRIV_H && HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY */
07ed0e9a MS	209	# if !defined(HAVE_SECPOLICYPRIV_H) && defined(HAVE_SECPOLICYSETVALUE) /* Declare prototype for function in that header... */
7cf5915e MS	210	extern OSStatus SecPolicySetValue(SecPolicyRef policyRef,
7cf5915e MS	211	const CSSM_DATA *value);
07ed0e9a	212	# endif /* !HAVE_SECPOLICYPRIV_H && HAVE_SECPOLICYSETVALUE */
7cf5915e MS	213
	214	typedef SSLContextRef http_tls_t;
	215	typedef CFArrayRef http_tls_credentials_t;
ef416fc2	216
	217	extern OSStatus _httpReadCDSA(SSLConnectionRef connection, void *data,
	218	size_t *dataLength);
	219	extern OSStatus _httpWriteCDSA(SSLConnectionRef connection, const void *data,
	220	size_t *dataLength);
cc754834 MS	221
cc754834 MS	222	# elif defined(HAVE_SSPISSL)
07ed0e9a MS	223	/*
	224	* Windows' SSPI library gets a CUPS wrapper...
	225	*/
	226
7cf5915e MS	227	typedef _sspi_struct_t * http_tls_t;
7cf5915e MS	228	typedef void *http_tls_credentials_t;
07ed0e9a	229
7cf5915e	230	# else
07ed0e9a MS	231	/*
	232	* Otherwise define stub types since we have no SSL support...
	233	*/
	234
7cf5915e	235	typedef void *http_tls_t;
07ed0e9a	236	typedef void *http_tls_credentials_t;
ef416fc2	237	# endif /* HAVE_LIBSSL */
ef416fc2	238
f7deaa1a	239	struct _http_s /** HTTP connection structure. **/
	240	{
	241	int fd; /* File descriptor for this socket */
	242	int blocking; /* To block or not to block */
	243	int error; /* Last error on read */
	244	time_t activity; /* Time since last read/write */
	245	http_state_t state; /* State of client */
	246	http_status_t status; /* Status of last request */
	247	http_version_t version; /* Protocol version */
	248	http_keepalive_t keep_alive; /* Keep-alive supported? */
85dda01c	249	struct sockaddr_in _hostaddr; /* Address of connected host (deprecated) */
f7deaa1a	250	char hostname[HTTP_MAX_HOST],
	251	/* Name of connected host */
	252	fields[HTTP_FIELD_MAX][HTTP_MAX_VALUE];
	253	/* Field values */
	254	char data; / Pointer to data buffer */
	255	http_encoding_t data_encoding; /* Chunked or not */
85dda01c	256	int _data_remaining;/* Number of bytes left (deprecated) */
f7deaa1a	257	int used; /* Number of bytes used in buffer */
	258	char buffer[HTTP_MAX_BUFFER];
	259	/* Buffer for incoming data */
	260	int auth_type; /* Authentication in use */
	261	_cups_md5_state_t md5_state; /* MD5 state */
	262	char nonce[HTTP_MAX_VALUE];
	263	/* Nonce value */
	264	int nonce_count; /* Nonce count */
7cf5915e	265	http_tls_t tls; /* TLS state information */
f7deaa1a	266	http_encryption_t encryption; /* Encryption requirements */
f7deaa1a	267	/** New in CUPS 1.1.19 **/
85dda01c MS	268	fd_set input_set; / select() set for httpWait() (deprecated) */
	269	http_status_t expect; /* Expect: header */
	270	char cookie; / Cookie value(s) */
f7deaa1a	271	/** New in CUPS 1.1.20 **/
f7deaa1a	272	char _authstring[HTTP_MAX_VALUE],
85dda01c	273	/* Current Authentication value (deprecated) */
f7deaa1a	274	userpass[HTTP_MAX_VALUE];
85dda01c MS	275	/* Username:password string */
85dda01c MS	276	int digest_tries; /* Number of tries for digest auth */
f7deaa1a	277	/** New in CUPS 1.2 **/
85dda01c MS	278	off_t data_remaining; /* Number of bytes left */
	279	http_addr_t hostaddr; / Current host address and port */
	280	http_addrlist_t addrlist; / List of valid addresses */
f7deaa1a	281	char wbuffer[HTTP_MAX_BUFFER];
f7deaa1a	282	/* Buffer for outgoing data */
85dda01c	283	int wused; /* Write buffer bytes used */
f7deaa1a	284	/** New in CUPS 1.3 **/
f7deaa1a	285	char *field_authorization;
85dda01c MS	286	/* Authorization field */
85dda01c MS	287	char authstring; / Current authorization field */
f7deaa1a	288	# ifdef HAVE_GSSAPI
85dda01c MS	289	gss_OID gssmech; /* Authentication mechanism */
	290	gss_ctx_id_t gssctx; /* Authentication context */
	291	gss_name_t gssname; /* Authentication server name */
f7deaa1a	292	# endif /* HAVE_GSSAPI */
b94498cf	293	# ifdef HAVE_AUTHORIZATION_H
85dda01c	294	AuthorizationRef auth_ref; /* Authorization ref */
b94498cf	295	# endif /* HAVE_AUTHORIZATION_H */
7cf5915e MS	296	/** New in CUPS 1.5 **/
7cf5915e MS	297	http_tls_credentials_t tls_credentials;
85dda01c MS	298	/* TLS credentials */
	299	http_timeout_cb_t timeout_cb; /* Timeout callback */
	300	void timeout_data; / User data pointer */
	301	double timeout_value; /* Timeout in seconds */
	302	int wait_value; /* httpWait value for timeout */
eac3a0a0 MS	303	# ifdef HAVE_GSSAPI
	304	char gsshost[256]; /* Hostname for Kerberos */
	305	# endif /* HAVE_GSSAPI */
f7deaa1a	306	};
	307
	308
ef416fc2	309	/*
	310	* Some OS's don't have hstrerror(), most notably Solaris...
	311	*/
	312
	313	# ifndef HAVE_HSTRERROR
	314	extern const char *_cups_hstrerror(int error);
	315	# define hstrerror _cups_hstrerror
	316	# elif defined(_AIX) \|\| defined(__osf__)
	317	/*
	318	* AIX and Tru64 UNIX don't provide a prototype but do provide the function...
	319	*/
	320	extern const char *hstrerror(int error);
	321	# endif /* !HAVE_HSTRERROR */
	322
89d46774	323
	324	/*
	325	* Some OS's don't have getifaddrs() and freeifaddrs()...
	326	*/
	327
07ed0e9a MS	328	# if !defined(WIN32) && !defined(HAVE_GETIFADDRS)
	329	# ifdef ifa_dstaddr
	330	# undef ifa_dstaddr
	331	# endif /* ifa_dstaddr */
	332	# ifndef ifr_netmask
	333	# define ifr_netmask ifr_addr
	334	# endif /* !ifr_netmask */
89d46774	335
	336	struct ifaddrs /** Interface Structure **/
	337	{
	338	struct ifaddrs ifa_next; / Next interface in list */
	339	char ifa_name; / Name of interface */
	340	unsigned int ifa_flags; /* Flags (up, point-to-point, etc.) */
	341	struct sockaddr ifa_addr, / Network address */
f301802f	342	ifa_netmask; / Address mask */
	343	union
	344	{
	345	struct sockaddr ifu_broadaddr; / Broadcast address of this interface. */
	346	struct sockaddr ifu_dstaddr; / Point-to-point destination address. */
	347	} ifa_ifu;
	348
89d46774	349	void ifa_data; / Interface statistics */
	350	};
	351
07ed0e9a MS	352	# ifndef ifa_broadaddr
	353	# define ifa_broadaddr ifa_ifu.ifu_broadaddr
	354	# endif /* !ifa_broadaddr */
	355	# ifndef ifa_dstaddr
	356	# define ifa_dstaddr ifa_ifu.ifu_dstaddr
	357	# endif /* !ifa_dstaddr */
f301802f	358
a74454a7	359	extern int _cups_getifaddrs(struct ifaddrs **addrs);
07ed0e9a	360	# define getifaddrs _cups_getifaddrs
a74454a7	361	extern void _cups_freeifaddrs(struct ifaddrs *addrs);
07ed0e9a MS	362	# define freeifaddrs _cups_freeifaddrs
	363	# endif /* !WIN32 && !HAVE_GETIFADDRS */
	364
89d46774	365
839a51c8	366	/*
1ff0402e	367	* Prototypes...
839a51c8 MS	368	*/
839a51c8 MS	369
22c9029b	370	#define _httpAddrFamily(addrp) (addrp)->addr.sa_family
1ff0402e	371	extern int _httpAddrPort(http_addr_t *addr);
22c9029b	372	extern void _httpAddrSetPort(http_addr_t *addr, int port);
07ed0e9a MS	373	extern char _httpAssembleUUID(const char server, int port,
	374	const char *name, int number,
	375	char *buffer, size_t bufsize);
1ff0402e	376	extern http_t _httpCreate(const char host, int port,
c8fef167 MS	377	http_addrlist_t *addrlist,
c8fef167 MS	378	http_encryption_t encryption,
1106b00e	379	int family);
85dda01c MS	380	extern http_tls_credentials_t
85dda01c MS	381	_httpCreateCredentials(cups_array_t *credentials);
1106b00e MS	382	extern char _httpDecodeURI(char dst, const char *src,
1106b00e MS	383	size_t dstsize);
6d2f911b	384	extern void _httpDisconnect(http_t *http);
5eb9da71 MS	385	extern char _httpEncodeURI(char dst, const char *src,
5eb9da71 MS	386	size_t dstsize);
7cf5915e	387	extern void _httpFreeCredentials(http_tls_credentials_t credentials);
6d2f911b	388	extern ssize_t _httpPeek(http_t http, char buffer, size_t length);
5eb9da71	389	extern const char _httpResolveURI(const char uri, char *resolved_uri,
eac3a0a0	390	size_t resolved_size, int options,
07ed0e9a MS	391	int (cb)(void context),
07ed0e9a MS	392	void *context);
e60ec91f	393	extern int _httpUpdate(http_t http, http_status_t status);
38e73f87	394	extern int _httpWait(http_t *http, int msec, int usessl);
6d2f911b MS	395
6d2f911b MS	396
07ed0e9a MS	397	/*
	398	* C++ magic...
	399	*/
	400
	401	# ifdef __cplusplus
	402	}
	403	# endif /* __cplusplus */
	404
ef416fc2	405	#endif /* !_CUPS_HTTP_PRIVATE_H_ */
	406
	407	/*
b19ccc9e	408	* End of "$Id: http-private.h 7850 2008-08-20 00:07:25Z mike $".
ef416fc2	409	*/