2 * "$Id: http-private.h 7850 2008-08-20 00:07:25Z mike $"
4 * Private HTTP definitions for the Common UNIX Printing System (CUPS).
6 * Copyright 2007-2008 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...
29 # include <sys/select.h>
35 # include <winsock2.h>
39 # include <sys/socket.h>
40 # define closesocket(f) close(f)
44 # ifdef HAVE_GSSAPI_GSSAPI_H
45 # include <gssapi/gssapi.h>
46 # endif /* HAVE_GSSAPI_GSSAPI_H */
47 # ifdef HAVE_GSSAPI_GSSAPI_GENERIC_H
48 # include <gssapi/gssapi_generic.h>
49 # endif /* HAVE_GSSAPI_GSSAPI_GENERIC_H */
50 # ifdef HAVE_GSSAPI_GSSAPI_KRB5_H
51 # include <gssapi/gssapi_krb5.h>
52 # endif /* HAVE_GSSAPI_GSSAPI_KRB5_H */
55 # endif /* HAVE_GSSAPI_H */
56 # ifndef HAVE_GSS_C_NT_HOSTBASED_SERVICE
57 # define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
58 # endif /* !HAVE_GSS_C_NT_HOSTBASED_SERVICE */
61 # endif /* HAVE_KRB5_H */
62 # endif /* HAVE_GSSAPI */
64 # ifdef HAVE_AUTHORIZATION_H
65 # include <Security/Authorization.h>
66 # endif /* HAVE_AUTHORIZATION_H */
68 # if defined(__sgi) || (defined(__APPLE__) && !defined(_SOCKLEN_T))
70 * IRIX and MacOS X 10.2.x do not define socklen_t, and in fact use an int instead of
71 * unsigned type for length values...
74 typedef int socklen_t
;
75 # endif /* __sgi || (__APPLE__ && !_SOCKLEN_T) */
79 # include "ipp-private.h"
81 # if defined HAVE_LIBSSL
83 * The OpenSSL library provides its own SSL/TLS context structure for its
84 * IO and protocol management. However, we need to provide our own BIO
85 * (basic IO) implementation to do timeouts...
88 # include <openssl/err.h>
89 # include <openssl/rand.h>
90 # include <openssl/ssl.h>
92 typedef SSL http_tls_t
;
94 extern BIO_METHOD
*_httpBIOMethods(void);
96 # elif defined HAVE_GNUTLS
98 * The GNU TLS library is more of a "bare metal" SSL/TLS library...
100 # include <gnutls/gnutls.h>
104 gnutls_session session
; /* GNU TLS session object */
105 void *credentials
; /* GNU TLS credentials object */
108 extern ssize_t
_httpReadGNUTLS(gnutls_transport_ptr ptr
, void *data
,
110 extern ssize_t
_httpWriteGNUTLS(gnutls_transport_ptr ptr
, const void *data
,
113 # elif defined(HAVE_CDSASSL)
115 * Darwin's Security framework provides its own SSL/TLS context structure
116 * for its IO and protocol management...
119 # include <Security/SecureTransport.h>
121 typedef struct /**** CDSA connection information ****/
123 SSLContextRef session
; /* CDSA session object */
124 CFArrayRef certsArray
; /* Certificates array */
127 extern OSStatus
_httpReadCDSA(SSLConnectionRef connection
, void *data
,
129 extern OSStatus
_httpWriteCDSA(SSLConnectionRef connection
, const void *data
,
131 # endif /* HAVE_LIBSSL */
134 struct _http_s
/**** HTTP connection structure. ****/
136 int fd
; /* File descriptor for this socket */
137 int blocking
; /* To block or not to block */
138 int error
; /* Last error on read */
139 time_t activity
; /* Time since last read/write */
140 http_state_t state
; /* State of client */
141 http_status_t status
; /* Status of last request */
142 http_version_t version
; /* Protocol version */
143 http_keepalive_t keep_alive
; /* Keep-alive supported? */
144 struct sockaddr_in _hostaddr
; /* Address of connected host @deprecated@ */
145 char hostname
[HTTP_MAX_HOST
],
146 /* Name of connected host */
147 fields
[HTTP_FIELD_MAX
][HTTP_MAX_VALUE
];
149 char *data
; /* Pointer to data buffer */
150 http_encoding_t data_encoding
; /* Chunked or not */
151 int _data_remaining
;/* Number of bytes left @deprecated@ */
152 int used
; /* Number of bytes used in buffer */
153 char buffer
[HTTP_MAX_BUFFER
];
154 /* Buffer for incoming data */
155 int auth_type
; /* Authentication in use */
156 _cups_md5_state_t md5_state
; /* MD5 state */
157 char nonce
[HTTP_MAX_VALUE
];
159 int nonce_count
; /* Nonce count */
160 void *tls
; /* TLS state information */
161 http_encryption_t encryption
; /* Encryption requirements */
162 /**** New in CUPS 1.1.19 ****/
163 fd_set
*input_set
; /* select() set for httpWait() @deprecated@ */
164 http_status_t expect
; /* Expect: header @since CUPS 1.1.19@ */
165 char *cookie
; /* Cookie value(s) @since CUPS 1.1.19@ */
166 /**** New in CUPS 1.1.20 ****/
167 char _authstring
[HTTP_MAX_VALUE
],
168 /* Current Authentication value. @deprecated@ */
169 userpass
[HTTP_MAX_VALUE
];
170 /* Username:password string @since CUPS 1.1.20@ */
171 int digest_tries
; /* Number of tries for digest auth @since CUPS 1.1.20@ */
172 /**** New in CUPS 1.2 ****/
173 off_t data_remaining
; /* Number of bytes left @since CUPS 1.2@ */
174 http_addr_t
*hostaddr
; /* Current host address and port @since CUPS 1.2@ */
175 http_addrlist_t
*addrlist
; /* List of valid addresses @since CUPS 1.2@ */
176 char wbuffer
[HTTP_MAX_BUFFER
];
177 /* Buffer for outgoing data */
178 int wused
; /* Write buffer bytes used @since CUPS 1.2@ */
179 /**** New in CUPS 1.3 ****/
180 char *field_authorization
;
181 /* Authorization field @since CUPS 1.3@ */
182 char *authstring
; /* Current authorization field @since CUPS 1.3 */
184 gss_OID gssmech
; /* Authentication mechanism @since CUPS 1.3@ */
185 gss_ctx_id_t gssctx
; /* Authentication context @since CUPS 1.3@ */
186 gss_name_t gssname
; /* Authentication server name @since CUPS 1.3@ */
187 # endif /* HAVE_GSSAPI */
188 # ifdef HAVE_AUTHORIZATION_H
189 AuthorizationRef auth_ref
; /* Authorization ref */
190 # endif /* HAVE_AUTHORIZATION_H */
195 * Some OS's don't have hstrerror(), most notably Solaris...
198 # ifndef HAVE_HSTRERROR
199 extern const char *_cups_hstrerror(int error
);
200 # define hstrerror _cups_hstrerror
201 # elif defined(_AIX) || defined(__osf__)
203 * AIX and Tru64 UNIX don't provide a prototype but do provide the function...
205 extern const char *hstrerror(int error
);
206 # endif /* !HAVE_HSTRERROR */
210 * Some OS's don't have getifaddrs() and freeifaddrs()...
215 # ifdef HAVE_GETIFADDRS
216 # include <ifaddrs.h>
218 # include <sys/ioctl.h>
219 # ifdef HAVE_SYS_SOCKIO_H
220 # include <sys/sockio.h>
221 # endif /* HAVE_SYS_SOCKIO_H */
225 # endif /* ifa_dstaddr */
227 # define ifr_netmask ifr_addr
228 # endif /* !ifr_netmask */
230 struct ifaddrs
/**** Interface Structure ****/
232 struct ifaddrs
*ifa_next
; /* Next interface in list */
233 char *ifa_name
; /* Name of interface */
234 unsigned int ifa_flags
; /* Flags (up, point-to-point, etc.) */
235 struct sockaddr
*ifa_addr
, /* Network address */
236 *ifa_netmask
; /* Address mask */
239 struct sockaddr
*ifu_broadaddr
; /* Broadcast address of this interface. */
240 struct sockaddr
*ifu_dstaddr
; /* Point-to-point destination address. */
243 void *ifa_data
; /* Interface statistics */
246 # ifndef ifa_broadaddr
247 # define ifa_broadaddr ifa_ifu.ifu_broadaddr
248 # endif /* !ifa_broadaddr */
250 # define ifa_dstaddr ifa_ifu.ifu_dstaddr
251 # endif /* !ifa_dstaddr */
253 extern int _cups_getifaddrs(struct ifaddrs
**addrs
);
254 # define getifaddrs _cups_getifaddrs
255 extern void _cups_freeifaddrs(struct ifaddrs
*addrs
);
256 # define freeifaddrs _cups_freeifaddrs
257 # endif /* HAVE_GETIFADDRS */
264 extern int _httpAddrPort(http_addr_t
*addr
);
265 extern http_t
*_httpCreate(const char *host
, int port
,
266 http_encryption_t encryption
);
267 extern char *_httpEncodeURI(char *dst
, const char *src
,
269 extern const char *_httpResolveURI(const char *uri
, char *resolved_uri
,
270 size_t resolved_size
, int log
);
271 #endif /* !_CUPS_HTTP_PRIVATE_H_ */
274 * End of "$Id: http-private.h 7850 2008-08-20 00:07:25Z mike $".