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

/*
 * "$Id$"
 *
 * Private HTTP definitions for CUPS.
 *
 * Copyright 2007-2014 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"

#  ifdef 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_SECCERTIFICATEPRIV_H
#      include <Security/SecCertificatePriv.h>
#    else
#      ifdef __cplusplus
extern "C" {
#      endif /* __cplusplus */
extern SecCertificateRef SecCertificateCreateWithBytes(CFAllocatorRef allocator, const UInt8 *bytes, CFIndex length);
extern bool SecCertificateIsValid(SecCertificateRef certificate, CFAbsoluteTime verifyTime);
extern CFAbsoluteTime SecCertificateNotValidAfter(SecCertificateRef certificate);
#      ifdef __cplusplus
}
#      endif /* __cplusplus */
#    endif /* HAVE_SECCERTIFICATEPRIV_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 <wincrypt.h>
#    include <wintrust.h>
#    include <schannel.h>
#    define SECURITY_WIN32
#    include <security.h>
#    include <sspi.h>
#  endif /* HAVE_GNUTLS */

#  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_MAX_SBUFFER	65536	/* Size of (de)compression buffer */
#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...
 */

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

typedef gnutls_session_t http_tls_t;
typedef gnutls_certificate_credentials_t *http_tls_credentials_t;

#  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 struct _http_sspi_s		/**** SSPI/SSL data structure ****/
{
  CredHandle	creds;			/* Credentials */
  CtxtHandle	context;		/* SSL context */
  BOOL		contextInitialized;	/* Is context init'd? */
  SecPkgContext_StreamSizes streamSizes;/* SSL data stream sizes */
  BYTE		*decryptBuffer;		/* Data pre-decryption*/
  size_t	decryptBufferLength;	/* Length of decrypt buffer */
  size_t	decryptBufferUsed;	/* Bytes used in buffer */
  BYTE		*readBuffer;		/* Data post-decryption */
  int		readBufferLength;	/* Length of read buffer */
  int		readBufferUsed;		/* Bytes used in buffer */
  BYTE		*writeBuffer;		/* Data pre-encryption */
  int		writeBufferLength;	/* Length of write buffer */
  PCCERT_CONTEXT localCert,		/* Local certificate */
		remoteCert;		/* Remote (peer's) certificate */
  char		error[256];		/* Most recent error message */
} _http_sspi_t;
typedef _http_sspi_t *http_tls_t;
typedef PCCERT_CONTEXT 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_GNUTLS */

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			*sbuffer;	/* (De)compression 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
#  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 void		_httpTLSInitialize(void);
extern size_t		_httpTLSPending(http_t *http);
extern int		_httpTLSRead(http_t *http, char *buf, int len);
extern int		_httpTLSSetCredentials(http_t *http);
extern int		_httpTLSStart(http_t *http);
extern void		_httpTLSStop(http_t *http);
extern int		_httpTLSWrite(http_t *http, const char *buf, int len);
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
ef416fc2	1	/*
f2d18633	2	* "$Id$"
ef416fc2	3	*
2c85b752	4	* Private HTTP definitions for CUPS.
ef416fc2	5	*
25731360	6	* Copyright 2007-2014 by Apple Inc.
2c85b752	7	* Copyright 1997-2007 by Easy Software Products, all rights reserved.
ef416fc2	8	*
2c85b752 MS	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/".
ef416fc2	14	*
2c85b752	15	* This file is subject to the Apple OS-Developed Software exception.
ef416fc2	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"
41e6c1f1	26	# include <cups/language.h>
5180a04c	27	# include <stddef.h>
a74454a7	28	# include <stdlib.h>
ef416fc2	29
ef416fc2	30	# ifdef __sun
ef416fc2	31	# include <sys/select.h>
	32	# endif /* __sun */
	33
	34	# include <limits.h>
	35	# ifdef WIN32
	36	# include <io.h>
	37	# include <winsock2.h>
db8b865d	38	# define CUPS_SOCAST (const char *)
ef416fc2	39	# else
	40	# include <unistd.h>
	41	# include <fcntl.h>
	42	# include <sys/socket.h>
db8b865d	43	# define CUPS_SOCAST
ef416fc2	44	# endif /* WIN32 */
ef416fc2	45
f7deaa1a	46	# ifdef HAVE_GSSAPI
eac3a0a0 MS	47	# ifdef HAVE_GSS_GSSAPI_H
eac3a0a0 MS	48	# include <GSS/gssapi.h>
eac3a0a0	49	# elif defined(HAVE_GSSAPI_GSSAPI_H)
f7deaa1a	50	# include <gssapi/gssapi.h>
eac3a0a0	51	# elif defined(HAVE_GSSAPI_H)
f7deaa1a	52	# include <gssapi.h>
eac3a0a0	53	# endif /* HAVE_GSS_GSSAPI_H */
f7deaa1a	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
b94498cf	59	# ifdef HAVE_AUTHORIZATION_H
	60	# include <Security/Authorization.h>
	61	# endif /* HAVE_AUTHORIZATION_H */
	62
3dd9c340	63	# if defined(__APPLE__) && !defined(_SOCKLEN_T)
ef416fc2	64	/*
3dd9c340	65	* MacOS X 10.2.x does not define socklen_t, and in fact uses an int instead of
ef416fc2	66	* unsigned type for length values...
	67	*/
	68
	69	typedef int socklen_t;
3dd9c340	70	# endif /* __APPLE__ && !_SOCKLEN_T */
ef416fc2	71
71e16022 MS	72	# include <cups/http.h>
71e16022 MS	73	# include "md5-private.h"
fa73b229	74	# include "ipp-private.h"
ef416fc2	75
724e1819	76	# ifdef HAVE_GNUTLS
07ed0e9a MS	77	# include <gnutls/gnutls.h>
	78	# include <gnutls/x509.h>
	79	# include <gcrypt.h>
	80	# elif defined(HAVE_CDSASSL)
	81	# include <CoreFoundation/CoreFoundation.h>
	82	# include <Security/Security.h>
	83	# include <Security/SecureTransport.h>
eac3a0a0 MS	84	# ifdef HAVE_SECURETRANSPORTPRIV_H
	85	# include <Security/SecureTransportPriv.h>
	86	# endif /* HAVE_SECURETRANSPORTPRIV_H */
07ed0e9a MS	87	# ifdef HAVE_SECITEM_H
	88	# include <Security/SecItem.h>
	89	# endif /* HAVE_SECITEM_H */
	90	# ifdef HAVE_SECBASEPRIV_H
	91	# include <Security/SecBasePriv.h>
	92	# endif /* HAVE_SECBASEPRIV_H */
	93	# ifdef HAVE_SECCERTIFICATE_H
	94	# include <Security/SecCertificate.h>
	95	# include <Security/SecIdentity.h>
	96	# endif /* HAVE_SECCERTIFICATE_H */
9653cfdf MS	97	# ifdef HAVE_SECCERTIFICATEPRIV_H
	98	# include <Security/SecCertificatePriv.h>
	99	# else
	100	# ifdef __cplusplus
	101	extern "C" {
	102	# endif /* __cplusplus */
	103	extern SecCertificateRef SecCertificateCreateWithBytes(CFAllocatorRef allocator, const UInt8 *bytes, CFIndex length);
	104	extern bool SecCertificateIsValid(SecCertificateRef certificate, CFAbsoluteTime verifyTime);
	105	extern CFAbsoluteTime SecCertificateNotValidAfter(SecCertificateRef certificate);
9653cfdf MS	106	# ifdef __cplusplus
	107	}
	108	# endif /* __cplusplus */
	109	# endif /* HAVE_SECCERTIFICATEPRIV_H */
07ed0e9a MS	110	# ifdef HAVE_SECITEMPRIV_H
	111	# include <Security/SecItemPriv.h>
	112	# endif /* HAVE_SECITEMPRIV_H */
	113	# ifdef HAVE_SECIDENTITYSEARCHPRIV_H
	114	# include <Security/SecIdentitySearchPriv.h>
	115	# endif /* HAVE_SECIDENTITYSEARCHPRIV_H */
	116	# ifdef HAVE_SECPOLICYPRIV_H
	117	# include <Security/SecPolicyPriv.h>
	118	# endif /* HAVE_SECPOLICYPRIV_H */
	119	# elif defined(HAVE_SSPISSL)
2ece34a9 MS	120	# include <wincrypt.h>
	121	# include <wintrust.h>
	122	# include <schannel.h>
	123	# define SECURITY_WIN32
	124	# include <security.h>
	125	# include <sspi.h>
724e1819	126	# endif /* HAVE_GNUTLS */
07ed0e9a MS	127
	128	# ifndef WIN32
	129	# include <net/if.h>
	130	# ifdef HAVE_GETIFADDRS
	131	# include <ifaddrs.h>
	132	# else
	133	# include <sys/ioctl.h>
	134	# ifdef HAVE_SYS_SOCKIO_H
	135	# include <sys/sockio.h>
	136	# endif /* HAVE_SYS_SOCKIO_H */
	137	# endif /* HAVE_GETIFADDRS */
	138	# endif /* !WIN32 */
	139
a469f8a5 MS	140	# ifdef HAVE_LIBZ
	141	# include <zlib.h>
	142	# endif /* HAVE_LIBZ */
	143
07ed0e9a MS	144
	145	/*
	146	* C++ magic...
	147	*/
	148
	149	# ifdef __cplusplus
	150	extern "C" {
	151	# endif /* __cplusplus */
	152
	153
eac3a0a0 MS	154	/*
	155	* Constants...
	156	*/
	157
	158
291e4727	159	#define _HTTP_MAX_SBUFFER 65536 /* Size of (de)compression buffer */
eac3a0a0 MS	160	#define _HTTP_RESOLVE_DEFAULT 0 /* Just resolve with default options */
	161	#define _HTTP_RESOLVE_STDERR 1 /* Log resolve progress to stderr */
	162	#define _HTTP_RESOLVE_FQDN 2 /* Resolve to a FQDN */
f3c17241	163	#define _HTTP_RESOLVE_FAXOUT 4 /* Resolve FaxOut service? */
eac3a0a0 MS	164
eac3a0a0 MS	165
07ed0e9a MS	166	/*
	167	* Types and functions for SSL support...
	168	*/
	169
724e1819	170	# ifdef HAVE_GNUTLS
ef416fc2	171	/*
	172	* The GNU TLS library is more of a "bare metal" SSL/TLS library...
	173	*/
ef416fc2	174
dd332638	175	typedef gnutls_session_t http_tls_t;
172bdf5d	176	typedef gnutls_certificate_credentials_t *http_tls_credentials_t;
ef416fc2	177
	178	# elif defined(HAVE_CDSASSL)
	179	/*
	180	* Darwin's Security framework provides its own SSL/TLS context structure
	181	* for its IO and protocol management...
	182	*/
	183
07ed0e9a	184	# if !defined(HAVE_SECBASEPRIV_H) && defined(HAVE_CSSMERRORSTRING) /* Declare prototype for function in that header... */
7cf5915e	185	extern const char *cssmErrorString(int error);
07ed0e9a MS	186	# endif /* !HAVE_SECBASEPRIV_H && HAVE_CSSMERRORSTRING */
07ed0e9a MS	187	# ifndef HAVE_SECITEMPRIV_H /* Declare constants from that header... */
7cf5915e MS	188	extern const CFTypeRef kSecClassCertificate;
7cf5915e MS	189	extern const CFTypeRef kSecClassIdentity;
07ed0e9a MS	190	# endif /* !HAVE_SECITEMPRIV_H */
07ed0e9a MS	191	# if !defined(HAVE_SECIDENTITYSEARCHPRIV_H) && defined(HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY) /* Declare prototype for function in that header... */
7cf5915e MS	192	extern OSStatus SecIdentitySearchCreateWithPolicy(SecPolicyRef policy,
	193	CFStringRef idString, CSSM_KEYUSE keyUsage,
	194	CFTypeRef keychainOrArray,
	195	Boolean returnOnlyValidIdentities,
	196	SecIdentitySearchRef* searchRef);
07ed0e9a MS	197	# endif /* !HAVE_SECIDENTITYSEARCHPRIV_H && HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY */
07ed0e9a MS	198	# if !defined(HAVE_SECPOLICYPRIV_H) && defined(HAVE_SECPOLICYSETVALUE) /* Declare prototype for function in that header... */
7cf5915e MS	199	extern OSStatus SecPolicySetValue(SecPolicyRef policyRef,
7cf5915e MS	200	const CSSM_DATA *value);
07ed0e9a	201	# endif /* !HAVE_SECPOLICYPRIV_H && HAVE_SECPOLICYSETVALUE */
7cf5915e MS	202
	203	typedef SSLContextRef http_tls_t;
	204	typedef CFArrayRef http_tls_credentials_t;
ef416fc2	205
cc754834	206	# elif defined(HAVE_SSPISSL)
07ed0e9a MS	207	/*
	208	* Windows' SSPI library gets a CUPS wrapper...
	209	*/
	210
2ece34a9 MS	211	typedef struct _http_sspi_s /** SSPI/SSL data structure **/
	212	{
	213	CredHandle creds; /* Credentials */
	214	CtxtHandle context; /* SSL context */
	215	BOOL contextInitialized; /* Is context init'd? */
	216	SecPkgContext_StreamSizes streamSizes;/* SSL data stream sizes */
	217	BYTE decryptBuffer; / Data pre-decryption*/
	218	size_t decryptBufferLength; /* Length of decrypt buffer */
	219	size_t decryptBufferUsed; /* Bytes used in buffer */
	220	BYTE readBuffer; / Data post-decryption */
	221	int readBufferLength; /* Length of read buffer */
	222	int readBufferUsed; /* Bytes used in buffer */
	223	BYTE writeBuffer; / Data pre-encryption */
	224	int writeBufferLength; /* Length of write buffer */
2ece34a9 MS	225	PCCERT_CONTEXT localCert, /* Local certificate */
2ece34a9 MS	226	remoteCert; /* Remote (peer's) certificate */
d777d26d	227	char error[256]; /* Most recent error message */
2ece34a9 MS	228	} _http_sspi_t;
2ece34a9 MS	229	typedef _http_sspi_t *http_tls_t;
17eecbf1	230	typedef PCCERT_CONTEXT http_tls_credentials_t;
07ed0e9a	231
7cf5915e	232	# else
07ed0e9a MS	233	/*
	234	* Otherwise define stub types since we have no SSL support...
	235	*/
	236
7cf5915e	237	typedef void *http_tls_t;
07ed0e9a	238	typedef void *http_tls_credentials_t;
724e1819	239	# endif /* HAVE_GNUTLS */
ef416fc2	240
a469f8a5 MS	241	typedef enum _http_coding_e /** HTTP content coding enumeration **/
	242	{
	243	_HTTP_CODING_IDENTITY, /* No content coding */
	244	_HTTP_CODING_GZIP, /* LZ77+gzip decompression */
	245	_HTTP_CODING_DEFLATE, /* LZ77+zlib compression */
	246	_HTTP_CODING_GUNZIP, /* LZ77+gzip decompression */
	247	_HTTP_CODING_INFLATE /* LZ77+zlib decompression */
	248	} _http_coding_t;
	249
	250	typedef enum _http_mode_e /** HTTP mode enumeration **/
	251	{
	252	_HTTP_MODE_CLIENT, /* Client connected to server */
	253	_HTTP_MODE_SERVER /* Server connected (accepted) from client */
	254	} _http_mode_t;
	255
5ec1fd3d	256	# ifndef _HTTP_NO_PRIVATE
a469f8a5	257	struct _http_s /** HTTP connection structure **/
f7deaa1a	258	{
	259	int fd; /* File descriptor for this socket */
	260	int blocking; /* To block or not to block */
	261	int error; /* Last error on read */
	262	time_t activity; /* Time since last read/write */
	263	http_state_t state; /* State of client */
	264	http_status_t status; /* Status of last request */
	265	http_version_t version; /* Protocol version */
	266	http_keepalive_t keep_alive; /* Keep-alive supported? */
85dda01c	267	struct sockaddr_in _hostaddr; /* Address of connected host (deprecated) */
f7deaa1a	268	char hostname[HTTP_MAX_HOST],
f7deaa1a	269	/* Name of connected host */
a469f8a5 MS	270	fields[HTTP_FIELD_ACCEPT_ENCODING][HTTP_MAX_VALUE];
a469f8a5 MS	271	/* Field values up to Accept-Encoding */
f7deaa1a	272	char data; / Pointer to data buffer */
f7deaa1a	273	http_encoding_t data_encoding; /* Chunked or not */
85dda01c	274	int _data_remaining;/* Number of bytes left (deprecated) */
f7deaa1a	275	int used; /* Number of bytes used in buffer */
	276	char buffer[HTTP_MAX_BUFFER];
	277	/* Buffer for incoming data */
5ec1fd3d	278	int _auth_type; /* Authentication in use (deprecated) */
f7deaa1a	279	_cups_md5_state_t md5_state; /* MD5 state */
	280	char nonce[HTTP_MAX_VALUE];
	281	/* Nonce value */
	282	int nonce_count; /* Nonce count */
7cf5915e	283	http_tls_t tls; /* TLS state information */
f7deaa1a	284	http_encryption_t encryption; /* Encryption requirements */
a469f8a5	285
f7deaa1a	286	/** New in CUPS 1.1.19 **/
85dda01c MS	287	fd_set input_set; / select() set for httpWait() (deprecated) */
	288	http_status_t expect; /* Expect: header */
	289	char cookie; / Cookie value(s) */
a469f8a5	290
f7deaa1a	291	/** New in CUPS 1.1.20 **/
f7deaa1a	292	char _authstring[HTTP_MAX_VALUE],
c1420c87	293	/* Current Authorization value (deprecated) */
f7deaa1a	294	userpass[HTTP_MAX_VALUE];
85dda01c MS	295	/* Username:password string */
85dda01c MS	296	int digest_tries; /* Number of tries for digest auth */
a469f8a5	297
f7deaa1a	298	/** New in CUPS 1.2 **/
85dda01c MS	299	off_t data_remaining; /* Number of bytes left */
	300	http_addr_t hostaddr; / Current host address and port */
	301	http_addrlist_t addrlist; / List of valid addresses */
f7deaa1a	302	char wbuffer[HTTP_MAX_BUFFER];
f7deaa1a	303	/* Buffer for outgoing data */
85dda01c	304	int wused; /* Write buffer bytes used */
a469f8a5	305
f7deaa1a	306	/** New in CUPS 1.3 **/
f7deaa1a	307	char *field_authorization;
85dda01c	308	/* Authorization field */
c1420c87	309	char authstring; / Current Authorization field */
f7deaa1a	310	# ifdef HAVE_GSSAPI
85dda01c MS	311	gss_OID gssmech; /* Authentication mechanism */
	312	gss_ctx_id_t gssctx; /* Authentication context */
	313	gss_name_t gssname; /* Authentication server name */
f7deaa1a	314	# endif /* HAVE_GSSAPI */
b94498cf	315	# ifdef HAVE_AUTHORIZATION_H
85dda01c	316	AuthorizationRef auth_ref; /* Authorization ref */
b94498cf	317	# endif /* HAVE_AUTHORIZATION_H */
a469f8a5	318
7cf5915e MS	319	/** New in CUPS 1.5 **/
7cf5915e MS	320	http_tls_credentials_t tls_credentials;
85dda01c MS	321	/* TLS credentials */
	322	http_timeout_cb_t timeout_cb; /* Timeout callback */
	323	void timeout_data; / User data pointer */
	324	double timeout_value; /* Timeout in seconds */
	325	int wait_value; /* httpWait value for timeout */
eac3a0a0 MS	326	# ifdef HAVE_GSSAPI
	327	char gsshost[256]; /* Hostname for Kerberos */
	328	# endif /* HAVE_GSSAPI */
a469f8a5 MS	329
a469f8a5 MS	330	/** New in CUPS 1.7 **/
cb7f98ee	331	int tls_upgrade; /* Non-zero if we are doing an upgrade */
a469f8a5 MS	332	_http_mode_t mode; /* _HTTP_MODE_CLIENT or _HTTP_MODE_SERVER */
	333	char *accept_encoding,
	334	/* Accept-Encoding field */
	335	allow, / Allow field */
c1420c87 MS	336	server, / Server field */
	337	*default_accept_encoding,
	338	*default_server,
	339	*default_user_agent;
	340	/* Default field values */
a469f8a5 MS	341	# ifdef HAVE_LIBZ
	342	_http_coding_t coding; /* _HTTP_CODING_xxx */
	343	z_stream stream; /* (De)compression stream */
291e4727	344	Bytef sbuffer; / (De)compression buffer */
a469f8a5	345	# endif /* HAVE_LIBZ */
f7deaa1a	346	};
5ec1fd3d	347	# endif /* !_HTTP_NO_PRIVATE */
f7deaa1a	348
f7deaa1a	349
ef416fc2	350	/*
	351	* Some OS's don't have hstrerror(), most notably Solaris...
	352	*/
	353
	354	# ifndef HAVE_HSTRERROR
	355	extern const char *_cups_hstrerror(int error);
	356	# define hstrerror _cups_hstrerror
ef416fc2	357	# endif /* !HAVE_HSTRERROR */
ef416fc2	358
89d46774	359
	360	/*
	361	* Some OS's don't have getifaddrs() and freeifaddrs()...
	362	*/
	363
07ed0e9a MS	364	# if !defined(WIN32) && !defined(HAVE_GETIFADDRS)
	365	# ifdef ifa_dstaddr
	366	# undef ifa_dstaddr
	367	# endif /* ifa_dstaddr */
	368	# ifndef ifr_netmask
	369	# define ifr_netmask ifr_addr
	370	# endif /* !ifr_netmask */
89d46774	371
	372	struct ifaddrs /** Interface Structure **/
	373	{
	374	struct ifaddrs ifa_next; / Next interface in list */
	375	char ifa_name; / Name of interface */
	376	unsigned int ifa_flags; /* Flags (up, point-to-point, etc.) */
	377	struct sockaddr ifa_addr, / Network address */
f301802f	378	ifa_netmask; / Address mask */
	379	union
	380	{
	381	struct sockaddr ifu_broadaddr; / Broadcast address of this interface. */
	382	struct sockaddr ifu_dstaddr; / Point-to-point destination address. */
	383	} ifa_ifu;
	384
89d46774	385	void ifa_data; / Interface statistics */
	386	};
	387
07ed0e9a MS	388	# ifndef ifa_broadaddr
	389	# define ifa_broadaddr ifa_ifu.ifu_broadaddr
	390	# endif /* !ifa_broadaddr */
	391	# ifndef ifa_dstaddr
	392	# define ifa_dstaddr ifa_ifu.ifu_dstaddr
	393	# endif /* !ifa_dstaddr */
f301802f	394
a74454a7	395	extern int _cups_getifaddrs(struct ifaddrs **addrs);
07ed0e9a	396	# define getifaddrs _cups_getifaddrs
a74454a7	397	extern void _cups_freeifaddrs(struct ifaddrs *addrs);
07ed0e9a MS	398	# define freeifaddrs _cups_freeifaddrs
	399	# endif /* !WIN32 && !HAVE_GETIFADDRS */
	400
89d46774	401
839a51c8	402	/*
1ff0402e	403	* Prototypes...
839a51c8 MS	404	*/
839a51c8 MS	405
22c9029b	406	extern void _httpAddrSetPort(http_addr_t *addr, int port);
85dda01c MS	407	extern http_tls_credentials_t
85dda01c MS	408	_httpCreateCredentials(cups_array_t *credentials);
1106b00e MS	409	extern char _httpDecodeURI(char dst, const char *src,
1106b00e MS	410	size_t dstsize);
6d2f911b	411	extern void _httpDisconnect(http_t *http);
5eb9da71 MS	412	extern char _httpEncodeURI(char dst, const char *src,
5eb9da71 MS	413	size_t dstsize);
7cf5915e	414	extern void _httpFreeCredentials(http_tls_credentials_t credentials);
5eb9da71	415	extern const char _httpResolveURI(const char uri, char *resolved_uri,
eac3a0a0	416	size_t resolved_size, int options,
07ed0e9a MS	417	int (cb)(void context),
07ed0e9a MS	418	void *context);
41e6c1f1	419	extern const char _httpStatus(cups_lang_t lang, http_status_t status);
25731360 MS	420	extern void _httpTLSInitialize(void);
	421	extern size_t _httpTLSPending(http_t *http);
	422	extern int _httpTLSRead(http_t http, char buf, int len);
	423	extern int _httpTLSSetCredentials(http_t *http);
	424	extern int _httpTLSStart(http_t *http);
	425	extern void _httpTLSStop(http_t *http);
	426	extern int _httpTLSWrite(http_t http, const char buf, int len);
e60ec91f	427	extern int _httpUpdate(http_t http, http_status_t status);
38e73f87	428	extern int _httpWait(http_t *http, int msec, int usessl);
6d2f911b MS	429
6d2f911b MS	430
07ed0e9a MS	431	/*
	432	* C++ magic...
	433	*/
	434
	435	# ifdef __cplusplus
	436	}
	437	# endif /* __cplusplus */
	438
ef416fc2	439	#endif /* !_CUPS_HTTP_PRIVATE_H_ */
	440
	441	/*
f2d18633	442	* End of "$Id$".
ef416fc2	443	*/