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

/*
 * Private HTTP definitions for CUPS.
 *
 * Copyright 2007-2018 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
 * 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 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 "ipp-private.h"

#  ifdef HAVE_GNUTLS
#    include <gnutls/gnutls.h>
#    include <gnutls/x509.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 */
#      ifndef _SECURITY_VERSION_GREATER_THAN_57610_
typedef CF_OPTIONS(uint32_t, SecKeyUsage) {
    kSecKeyUsageAll              = 0x7FFFFFFF
};
#       endif /* !_SECURITY_VERSION_GREATER_THAN_57610_ */
extern const void * kSecCSRChallengePassword;
extern const void * kSecSubjectAltName;
extern const void * kSecCertificateKeyUsage;
extern const void * kSecCSRBasicContraintsPathLen;
extern const void * kSecCertificateExtensions;
extern const void * kSecCertificateExtensionsEncoded;
extern const void * kSecOidCommonName;
extern const void * kSecOidCountryName;
extern const void * kSecOidStateProvinceName;
extern const void * kSecOidLocalityName;
extern const void * kSecOidOrganization;
extern const void * kSecOidOrganizationalUnit;
extern SecCertificateRef SecCertificateCreateWithBytes(CFAllocatorRef allocator, const UInt8 *bytes, CFIndex length);
extern bool SecCertificateIsValid(SecCertificateRef certificate, CFAbsoluteTime verifyTime);
extern CFAbsoluteTime SecCertificateNotValidAfter(SecCertificateRef certificate);
extern SecCertificateRef SecGenerateSelfSignedCertificate(CFArrayRef subject, CFDictionaryRef parameters, SecKeyRef publicKey, SecKeyRef privateKey);
extern SecIdentityRef SecIdentityCreate(CFAllocatorRef allocator, SecCertificateRef certificate, SecKeyRef privateKey);
#      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>
#    include <resolv.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? */

#  define _HTTP_TLS_NONE	0	/* No TLS options */
#  define _HTTP_TLS_ALLOW_RC4	1	/* Allow RC4 cipher suites */
#  define _HTTP_TLS_ALLOW_DH	2	/* Allow DH/DHE key negotiation */
#  define _HTTP_TLS_DENY_CBC	4	/* Deny CBC cipher suites */
#  define _HTTP_TLS_SET_DEFAULT 128     /* Setting the default TLS options */

#  define _HTTP_TLS_SSL3	0	/* Min/max version is SSL/3.0 */
#  define _HTTP_TLS_1_0		1	/* Min/max version is TLS/1.0 */
#  define _HTTP_TLS_1_1		2	/* Min/max version is TLS/1.1 */
#  define _HTTP_TLS_1_2		3	/* Min/max version is TLS/1.2 */
#  define _HTTP_TLS_1_3		4	/* Min/max version is TLS/1.3 */
#  define _HTTP_TLS_MAX		5	/* Highest known TLS version */


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