[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.
 *
 * Licensed under Apache License v2.0.  See the file "LICENSE" for more
 * information.
 */

#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 (deprecated) */
  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			*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 */
#  ifdef HAVE_LIBZ
  _http_coding_t	coding;		/* _HTTP_CODING_xxx */
  z_stream		stream;		/* (De)compression stream */
  Bytef			*sbuffer;	/* (De)compression buffer */
#  endif /* HAVE_LIBZ */

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