2 * "$Id: http-private.h 6934 2007-09-10 16:46:20Z mike $"
4 * Private HTTP definitions for the Common UNIX Printing System (CUPS).
6 * Copyright 2007 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
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/".
15 * This file is subject to the Apple OS-Developed Software exception.
18 #ifndef _CUPS_HTTP_PRIVATE_H_
19 # define _CUPS_HTTP_PRIVATE_H_
22 * Include necessary headers...
30 * Define FD_SETSIZE to CUPS_MAX_FDS on Solaris to get the correct version of
31 * select() for large numbers of file descriptors.
34 # define FD_SETSIZE CUPS_MAX_FDS
35 # include <sys/select.h>
41 # include <winsock2.h>
45 # include <sys/socket.h>
46 # define closesocket(f) close(f)
50 # ifdef HAVE_GSSAPI_GSSAPI_H
51 # include <gssapi/gssapi.h>
52 # endif /* HAVE_GSSAPI_GSSAPI_H */
53 # ifdef HAVE_GSSAPI_GSSAPI_GENERIC_H
54 # include <gssapi/gssapi_generic.h>
55 # endif /* HAVE_GSSAPI_GSSAPI_GENERIC_H */
56 # ifdef HAVE_GSSAPI_GSSAPI_KRB5_H
57 # include <gssapi/gssapi_krb5.h>
58 # endif /* HAVE_GSSAPI_GSSAPI_KRB5_H */
61 # endif /* HAVE_GSSAPI_H */
62 # ifndef HAVE_GSS_C_NT_HOSTBASED_SERVICE
63 # define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
64 # endif /* !HAVE_GSS_C_NT_HOSTBASED_SERVICE */
67 # endif /* HAVE_KRB5_H */
68 # endif /* HAVE_GSSAPI */
70 # ifdef HAVE_AUTHORIZATION_H
71 # include <Security/Authorization.h>
72 # endif /* HAVE_AUTHORIZATION_H */
74 # if defined(__sgi) || (defined(__APPLE__) && !defined(_SOCKLEN_T))
76 * IRIX and MacOS X 10.2.x do not define socklen_t, and in fact use an int instead of
77 * unsigned type for length values...
80 typedef int socklen_t
;
81 # endif /* __sgi || (__APPLE__ && !_SOCKLEN_T) */
85 # include "ipp-private.h"
87 # if defined HAVE_LIBSSL
89 * The OpenSSL library provides its own SSL/TLS context structure for its
90 * IO and protocol management. However, we need to provide our own BIO
91 * (basic IO) implementation to do timeouts...
94 # include <openssl/err.h>
95 # include <openssl/rand.h>
96 # include <openssl/ssl.h>
98 typedef SSL http_tls_t
;
100 extern BIO_METHOD
*_httpBIOMethods(void);
102 # elif defined HAVE_GNUTLS
104 * The GNU TLS library is more of a "bare metal" SSL/TLS library...
106 # include <gnutls/gnutls.h>
110 gnutls_session session
; /* GNU TLS session object */
111 void *credentials
; /* GNU TLS credentials object */
114 extern ssize_t
_httpReadGNUTLS(gnutls_transport_ptr ptr
, void *data
,
116 extern ssize_t
_httpWriteGNUTLS(gnutls_transport_ptr ptr
, const void *data
,
119 # elif defined(HAVE_CDSASSL)
121 * Darwin's Security framework provides its own SSL/TLS context structure
122 * for its IO and protocol management...
125 # include <Security/SecureTransport.h>
127 typedef struct /**** CDSA connection information ****/
129 SSLContextRef session
; /* CDSA session object */
130 CFArrayRef certsArray
; /* Certificates array */
133 extern OSStatus
_httpReadCDSA(SSLConnectionRef connection
, void *data
,
135 extern OSStatus
_httpWriteCDSA(SSLConnectionRef connection
, const void *data
,
137 # endif /* HAVE_LIBSSL */
140 struct _http_s
/**** HTTP connection structure. ****/
142 int fd
; /* File descriptor for this socket */
143 int blocking
; /* To block or not to block */
144 int error
; /* Last error on read */
145 time_t activity
; /* Time since last read/write */
146 http_state_t state
; /* State of client */
147 http_status_t status
; /* Status of last request */
148 http_version_t version
; /* Protocol version */
149 http_keepalive_t keep_alive
; /* Keep-alive supported? */
150 struct sockaddr_in _hostaddr
; /* Address of connected host @deprecated@ */
151 char hostname
[HTTP_MAX_HOST
],
152 /* Name of connected host */
153 fields
[HTTP_FIELD_MAX
][HTTP_MAX_VALUE
];
155 char *data
; /* Pointer to data buffer */
156 http_encoding_t data_encoding
; /* Chunked or not */
157 int _data_remaining
;/* Number of bytes left @deprecated@ */
158 int used
; /* Number of bytes used in buffer */
159 char buffer
[HTTP_MAX_BUFFER
];
160 /* Buffer for incoming data */
161 int auth_type
; /* Authentication in use */
162 _cups_md5_state_t md5_state
; /* MD5 state */
163 char nonce
[HTTP_MAX_VALUE
];
165 int nonce_count
; /* Nonce count */
166 void *tls
; /* TLS state information */
167 http_encryption_t encryption
; /* Encryption requirements */
168 /**** New in CUPS 1.1.19 ****/
169 fd_set
*input_set
; /* select() set for httpWait() @deprecated@ */
170 http_status_t expect
; /* Expect: header @since CUPS 1.1.19@ */
171 char *cookie
; /* Cookie value(s) @since CUPS 1.1.19@ */
172 /**** New in CUPS 1.1.20 ****/
173 char _authstring
[HTTP_MAX_VALUE
],
174 /* Current Authentication value. @deprecated@ */
175 userpass
[HTTP_MAX_VALUE
];
176 /* Username:password string @since CUPS 1.1.20@ */
177 int digest_tries
; /* Number of tries for digest auth @since CUPS 1.1.20@ */
178 /**** New in CUPS 1.2 ****/
179 off_t data_remaining
; /* Number of bytes left @since CUPS 1.2@ */
180 http_addr_t
*hostaddr
; /* Current host address and port @since CUPS 1.2@ */
181 http_addrlist_t
*addrlist
; /* List of valid addresses @since CUPS 1.2@ */
182 char wbuffer
[HTTP_MAX_BUFFER
];
183 /* Buffer for outgoing data */
184 int wused
; /* Write buffer bytes used @since CUPS 1.2@ */
185 /**** New in CUPS 1.3 ****/
186 char *field_authorization
;
187 /* Authorization field @since CUPS 1.3@ */
188 char *authstring
; /* Current authorization field @since CUPS 1.3 */
190 gss_OID gssmech
; /* Authentication mechanism @since CUPS 1.3@ */
191 gss_ctx_id_t gssctx
; /* Authentication context @since CUPS 1.3@ */
192 gss_name_t gssname
; /* Authentication server name @since CUPS 1.3@ */
193 # endif /* HAVE_GSSAPI */
194 # ifdef HAVE_AUTHORIZATION_H
195 AuthorizationRef auth_ref
; /* Authorization ref */
196 # endif /* HAVE_AUTHORIZATION_H */
201 * Some OS's don't have hstrerror(), most notably Solaris...
204 # ifndef HAVE_HSTRERROR
205 extern const char *_cups_hstrerror(int error
);
206 # define hstrerror _cups_hstrerror
207 # elif defined(_AIX) || defined(__osf__)
209 * AIX and Tru64 UNIX don't provide a prototype but do provide the function...
211 extern const char *hstrerror(int error
);
212 # endif /* !HAVE_HSTRERROR */
216 * Some OS's don't have getifaddrs() and freeifaddrs()...
221 # ifdef HAVE_GETIFADDRS
222 # include <ifaddrs.h>
224 # include <sys/ioctl.h>
225 # ifdef HAVE_SYS_SOCKIO_H
226 # include <sys/sockio.h>
227 # endif /* HAVE_SYS_SOCKIO_H */
231 # endif /* ifa_dstaddr */
233 # define ifr_netmask ifr_addr
234 # endif /* !ifr_netmask */
236 struct ifaddrs
/**** Interface Structure ****/
238 struct ifaddrs
*ifa_next
; /* Next interface in list */
239 char *ifa_name
; /* Name of interface */
240 unsigned int ifa_flags
; /* Flags (up, point-to-point, etc.) */
241 struct sockaddr
*ifa_addr
, /* Network address */
242 *ifa_netmask
; /* Address mask */
245 struct sockaddr
*ifu_broadaddr
; /* Broadcast address of this interface. */
246 struct sockaddr
*ifu_dstaddr
; /* Point-to-point destination address. */
249 void *ifa_data
; /* Interface statistics */
252 # ifndef ifa_broadaddr
253 # define ifa_broadaddr ifa_ifu.ifu_broadaddr
254 # endif /* !ifa_broadaddr */
256 # define ifa_dstaddr ifa_ifu.ifu_dstaddr
257 # endif /* !ifa_dstaddr */
259 extern int _cups_getifaddrs(struct ifaddrs
**addrs
);
260 # define getifaddrs _cups_getifaddrs
261 extern void _cups_freeifaddrs(struct ifaddrs
*addrs
);
262 # define freeifaddrs _cups_freeifaddrs
263 # endif /* HAVE_GETIFADDRS */
266 #endif /* !_CUPS_HTTP_PRIVATE_H_ */
269 * End of "$Id: http-private.h 6934 2007-09-10 16:46:20Z mike $".