4 * Private HTTP definitions for CUPS.
6 * Copyright 2007-2013 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...
26 # include <cups/language.h>
31 # include <sys/select.h>
37 # include <winsock2.h>
38 # define CUPS_SOCAST (const char *)
42 # include <sys/socket.h>
47 # ifdef HAVE_GSS_GSSAPI_H
48 # include <GSS/gssapi.h>
49 # elif defined(HAVE_GSSAPI_GSSAPI_H)
50 # include <gssapi/gssapi.h>
51 # elif defined(HAVE_GSSAPI_H)
53 # endif /* HAVE_GSS_GSSAPI_H */
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 */
59 # ifdef HAVE_AUTHORIZATION_H
60 # include <Security/Authorization.h>
61 # endif /* HAVE_AUTHORIZATION_H */
63 # if defined(__APPLE__) && !defined(_SOCKLEN_T)
65 * MacOS X 10.2.x does not define socklen_t, and in fact uses an int instead of
66 * unsigned type for length values...
69 typedef int socklen_t
;
70 # endif /* __APPLE__ && !_SOCKLEN_T */
72 # include <cups/http.h>
73 # include "md5-private.h"
74 # include "ipp-private.h"
76 # if defined HAVE_LIBSSL
77 # include <openssl/err.h>
78 # include <openssl/rand.h>
79 # include <openssl/ssl.h>
80 # elif defined HAVE_GNUTLS
81 # include <gnutls/gnutls.h>
82 # include <gnutls/x509.h>
84 # elif defined(HAVE_CDSASSL)
85 # include <CoreFoundation/CoreFoundation.h>
86 # include <Security/Security.h>
87 # include <Security/SecureTransport.h>
88 # ifdef HAVE_SECURETRANSPORTPRIV_H
89 # include <Security/SecureTransportPriv.h>
90 # endif /* HAVE_SECURETRANSPORTPRIV_H */
91 # ifdef HAVE_SECITEM_H
92 # include <Security/SecItem.h>
93 # endif /* HAVE_SECITEM_H */
94 # ifdef HAVE_SECBASEPRIV_H
95 # include <Security/SecBasePriv.h>
96 # endif /* HAVE_SECBASEPRIV_H */
97 # ifdef HAVE_SECCERTIFICATE_H
98 # include <Security/SecCertificate.h>
99 # include <Security/SecIdentity.h>
100 # endif /* HAVE_SECCERTIFICATE_H */
101 # ifdef HAVE_SECITEMPRIV_H
102 # include <Security/SecItemPriv.h>
103 # endif /* HAVE_SECITEMPRIV_H */
104 # ifdef HAVE_SECIDENTITYSEARCHPRIV_H
105 # include <Security/SecIdentitySearchPriv.h>
106 # endif /* HAVE_SECIDENTITYSEARCHPRIV_H */
107 # ifdef HAVE_SECPOLICYPRIV_H
108 # include <Security/SecPolicyPriv.h>
109 # endif /* HAVE_SECPOLICYPRIV_H */
110 # elif defined(HAVE_SSPISSL)
111 # include "sspi-private.h"
112 # endif /* HAVE_LIBSSL */
116 # ifdef HAVE_GETIFADDRS
117 # include <ifaddrs.h>
119 # include <sys/ioctl.h>
120 # ifdef HAVE_SYS_SOCKIO_H
121 # include <sys/sockio.h>
122 # endif /* HAVE_SYS_SOCKIO_H */
123 # endif /* HAVE_GETIFADDRS */
128 # endif /* HAVE_LIBZ */
137 # endif /* __cplusplus */
145 #define _HTTP_RESOLVE_DEFAULT 0 /* Just resolve with default options */
146 #define _HTTP_RESOLVE_STDERR 1 /* Log resolve progress to stderr */
147 #define _HTTP_RESOLVE_FQDN 2 /* Resolve to a FQDN */
148 #define _HTTP_RESOLVE_FAXOUT 4 /* Resolve FaxOut service? */
152 * Types and functions for SSL support...
155 # if defined HAVE_LIBSSL
157 * The OpenSSL library provides its own SSL/TLS context structure for its
158 * IO and protocol management. However, we need to provide our own BIO
159 * (basic IO) implementation to do timeouts...
162 typedef SSL
*http_tls_t
;
163 typedef void *http_tls_credentials_t
;
165 //extern BIO_METHOD *_httpBIOMethods(void);
167 # elif defined HAVE_GNUTLS
169 * The GNU TLS library is more of a "bare metal" SSL/TLS library...
172 typedef gnutls_session http_tls_t
;
173 typedef void *http_tls_credentials_t
;
175 //extern ssize_t _httpReadGNUTLS(gnutls_transport_ptr ptr, void *data,
177 //extern ssize_t _httpWriteGNUTLS(gnutls_transport_ptr ptr, const void *data,
180 # elif defined(HAVE_CDSASSL)
182 * Darwin's Security framework provides its own SSL/TLS context structure
183 * for its IO and protocol management...
186 # if !defined(HAVE_SECBASEPRIV_H) && defined(HAVE_CSSMERRORSTRING) /* Declare prototype for function in that header... */
187 extern const char *cssmErrorString(int error
);
188 # endif /* !HAVE_SECBASEPRIV_H && HAVE_CSSMERRORSTRING */
189 # ifndef HAVE_SECITEMPRIV_H /* Declare constants from that header... */
190 extern const CFTypeRef kSecClassCertificate
;
191 extern const CFTypeRef kSecClassIdentity
;
192 # endif /* !HAVE_SECITEMPRIV_H */
193 # if !defined(HAVE_SECIDENTITYSEARCHPRIV_H) && defined(HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY) /* Declare prototype for function in that header... */
194 extern OSStatus
SecIdentitySearchCreateWithPolicy(SecPolicyRef policy
,
195 CFStringRef idString
, CSSM_KEYUSE keyUsage
,
196 CFTypeRef keychainOrArray
,
197 Boolean returnOnlyValidIdentities
,
198 SecIdentitySearchRef
* searchRef
);
199 # endif /* !HAVE_SECIDENTITYSEARCHPRIV_H && HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY */
200 # if !defined(HAVE_SECPOLICYPRIV_H) && defined(HAVE_SECPOLICYSETVALUE) /* Declare prototype for function in that header... */
201 extern OSStatus
SecPolicySetValue(SecPolicyRef policyRef
,
202 const CSSM_DATA
*value
);
203 # endif /* !HAVE_SECPOLICYPRIV_H && HAVE_SECPOLICYSETVALUE */
205 typedef SSLContextRef http_tls_t
;
206 typedef CFArrayRef http_tls_credentials_t
;
208 # elif defined(HAVE_SSPISSL)
210 * Windows' SSPI library gets a CUPS wrapper...
213 typedef _sspi_struct_t
* http_tls_t
;
214 typedef void *http_tls_credentials_t
;
218 * Otherwise define stub types since we have no SSL support...
221 typedef void *http_tls_t
;
222 typedef void *http_tls_credentials_t
;
223 # endif /* HAVE_LIBSSL */
225 typedef enum _http_coding_e
/**** HTTP content coding enumeration ****/
227 _HTTP_CODING_IDENTITY
, /* No content coding */
228 _HTTP_CODING_GZIP
, /* LZ77+gzip decompression */
229 _HTTP_CODING_DEFLATE
, /* LZ77+zlib compression */
230 _HTTP_CODING_GUNZIP
, /* LZ77+gzip decompression */
231 _HTTP_CODING_INFLATE
/* LZ77+zlib decompression */
234 typedef enum _http_mode_e
/**** HTTP mode enumeration ****/
236 _HTTP_MODE_CLIENT
, /* Client connected to server */
237 _HTTP_MODE_SERVER
/* Server connected (accepted) from client */
240 # ifndef _HTTP_NO_PRIVATE
241 struct _http_s
/**** HTTP connection structure ****/
243 int fd
; /* File descriptor for this socket */
244 int blocking
; /* To block or not to block */
245 int error
; /* Last error on read */
246 time_t activity
; /* Time since last read/write */
247 http_state_t state
; /* State of client */
248 http_status_t status
; /* Status of last request */
249 http_version_t version
; /* Protocol version */
250 http_keepalive_t keep_alive
; /* Keep-alive supported? */
251 struct sockaddr_in _hostaddr
; /* Address of connected host (deprecated) */
252 char hostname
[HTTP_MAX_HOST
],
253 /* Name of connected host */
254 fields
[HTTP_FIELD_ACCEPT_ENCODING
][HTTP_MAX_VALUE
];
255 /* Field values up to Accept-Encoding */
256 char *data
; /* Pointer to data buffer */
257 http_encoding_t data_encoding
; /* Chunked or not */
258 int _data_remaining
;/* Number of bytes left (deprecated) */
259 int used
; /* Number of bytes used in buffer */
260 char buffer
[HTTP_MAX_BUFFER
];
261 /* Buffer for incoming data */
262 int _auth_type
; /* Authentication in use (deprecated) */
263 _cups_md5_state_t md5_state
; /* MD5 state */
264 char nonce
[HTTP_MAX_VALUE
];
266 int nonce_count
; /* Nonce count */
267 http_tls_t tls
; /* TLS state information */
268 http_encryption_t encryption
; /* Encryption requirements */
270 /**** New in CUPS 1.1.19 ****/
271 fd_set
*input_set
; /* select() set for httpWait() (deprecated) */
272 http_status_t expect
; /* Expect: header */
273 char *cookie
; /* Cookie value(s) */
275 /**** New in CUPS 1.1.20 ****/
276 char _authstring
[HTTP_MAX_VALUE
],
277 /* Current Authorization value (deprecated) */
278 userpass
[HTTP_MAX_VALUE
];
279 /* Username:password string */
280 int digest_tries
; /* Number of tries for digest auth */
282 /**** New in CUPS 1.2 ****/
283 off_t data_remaining
; /* Number of bytes left */
284 http_addr_t
*hostaddr
; /* Current host address and port */
285 http_addrlist_t
*addrlist
; /* List of valid addresses */
286 char wbuffer
[HTTP_MAX_BUFFER
];
287 /* Buffer for outgoing data */
288 int wused
; /* Write buffer bytes used */
290 /**** New in CUPS 1.3 ****/
291 char *field_authorization
;
292 /* Authorization field */
293 char *authstring
; /* Current Authorization field */
295 gss_OID gssmech
; /* Authentication mechanism */
296 gss_ctx_id_t gssctx
; /* Authentication context */
297 gss_name_t gssname
; /* Authentication server name */
298 # endif /* HAVE_GSSAPI */
299 # ifdef HAVE_AUTHORIZATION_H
300 AuthorizationRef auth_ref
; /* Authorization ref */
301 # endif /* HAVE_AUTHORIZATION_H */
303 /**** New in CUPS 1.5 ****/
304 http_tls_credentials_t tls_credentials
;
305 /* TLS credentials */
306 http_timeout_cb_t timeout_cb
; /* Timeout callback */
307 void *timeout_data
; /* User data pointer */
308 double timeout_value
; /* Timeout in seconds */
309 int wait_value
; /* httpWait value for timeout */
311 char gsshost
[256]; /* Hostname for Kerberos */
312 # endif /* HAVE_GSSAPI */
314 /**** New in CUPS 1.7 ****/
315 int tls_upgrade
; /* Non-zero if we are doing an upgrade */
316 _http_mode_t mode
; /* _HTTP_MODE_CLIENT or _HTTP_MODE_SERVER */
317 char *accept_encoding
,
318 /* Accept-Encoding field */
319 *allow
, /* Allow field */
320 *server
, /* Server field */
321 *default_accept_encoding
,
324 /* Default field values */
326 _http_coding_t coding
; /* _HTTP_CODING_xxx */
327 z_stream stream
; /* (De)compression stream */
328 Bytef
*dbuffer
; /* Decompression buffer */
329 # endif /* HAVE_LIBZ */
331 # endif /* !_HTTP_NO_PRIVATE */
335 * Some OS's don't have hstrerror(), most notably Solaris...
338 # ifndef HAVE_HSTRERROR
339 extern const char *_cups_hstrerror(int error
);
340 # define hstrerror _cups_hstrerror
341 # endif /* !HAVE_HSTRERROR */
345 * Some OS's don't have getifaddrs() and freeifaddrs()...
348 # if !defined(WIN32) && !defined(HAVE_GETIFADDRS)
351 # endif /* ifa_dstaddr */
353 # define ifr_netmask ifr_addr
354 # endif /* !ifr_netmask */
356 struct ifaddrs
/**** Interface Structure ****/
358 struct ifaddrs
*ifa_next
; /* Next interface in list */
359 char *ifa_name
; /* Name of interface */
360 unsigned int ifa_flags
; /* Flags (up, point-to-point, etc.) */
361 struct sockaddr
*ifa_addr
, /* Network address */
362 *ifa_netmask
; /* Address mask */
365 struct sockaddr
*ifu_broadaddr
; /* Broadcast address of this interface. */
366 struct sockaddr
*ifu_dstaddr
; /* Point-to-point destination address. */
369 void *ifa_data
; /* Interface statistics */
372 # ifndef ifa_broadaddr
373 # define ifa_broadaddr ifa_ifu.ifu_broadaddr
374 # endif /* !ifa_broadaddr */
376 # define ifa_dstaddr ifa_ifu.ifu_dstaddr
377 # endif /* !ifa_dstaddr */
379 extern int _cups_getifaddrs(struct ifaddrs
**addrs
);
380 # define getifaddrs _cups_getifaddrs
381 extern void _cups_freeifaddrs(struct ifaddrs
*addrs
);
382 # define freeifaddrs _cups_freeifaddrs
383 # endif /* !WIN32 && !HAVE_GETIFADDRS */
390 extern void _httpAddrSetPort(http_addr_t
*addr
, int port
);
391 extern http_tls_credentials_t
392 _httpCreateCredentials(cups_array_t
*credentials
);
393 extern char *_httpDecodeURI(char *dst
, const char *src
,
395 extern void _httpDisconnect(http_t
*http
);
396 extern char *_httpEncodeURI(char *dst
, const char *src
,
398 extern void _httpFreeCredentials(http_tls_credentials_t credentials
);
399 extern const char *_httpResolveURI(const char *uri
, char *resolved_uri
,
400 size_t resolved_size
, int options
,
401 int (*cb
)(void *context
),
403 extern const char *_httpStatus(cups_lang_t
*lang
, http_status_t status
);
404 extern int _httpUpdate(http_t
*http
, http_status_t
*status
);
405 extern int _httpWait(http_t
*http
, int msec
, int usessl
);
414 # endif /* __cplusplus */
416 #endif /* !_CUPS_HTTP_PRIVATE_H_ */