cups/http-private.h

   1 /*
   2  * "$Id: http-private.h 7850 2008-08-20 00:07:25Z mike $"
   3  *
   4  *   Private HTTP definitions for CUPS.
   5  *
   6  *   Copyright 2007-2011 by Apple Inc.
   7  *   Copyright 1997-2007 by Easy Software Products, all rights reserved.
   8  *
   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/".
  14  *
  15  *   This file is subject to the Apple OS-Developed Software exception.
  16  */
  17
  18 #ifndef _CUPS_HTTP_PRIVATE_H_
  19 #  define _CUPS_HTTP_PRIVATE_H_
  20
  21 /*
  22  * Include necessary headers...
  23  */
  24
  25 #  include "config.h"
  26 #  include <stddef.h>
  27 #  include <stdlib.h>
  28
  29 #  ifdef __sun
  30 #    include <sys/select.h>
  31 #  endif /* __sun */
  32
  33 #  include <limits.h>
  34 #  ifdef WIN32
  35 #    include <io.h>
  36 #    include <winsock2.h>
  37 #  else
  38 #    include <unistd.h>
  39 #    include <fcntl.h>
  40 #    include <sys/socket.h>
  41 #    define closesocket(f) close(f)
  42 #  endif /* WIN32 */
  43
  44 #  ifdef HAVE_GSSAPI
  45 #    ifdef HAVE_GSS_GSSAPI_H
  46 #      include <GSS/gssapi.h>
  47 #      ifdef HAVE_GSSAPI_GENERIC_H
  48 #        include <GSS/gssapi_generic.h>
  49 #      endif /* HAVE_GSSAPI_GENERIC_H */
  50 #      ifdef HAVE_GSSAPI_KRB5_H
  51 #        include <GSS/gssapi_krb5.h>
  52 #      endif /* HAVE_GSSAPI_KRB5_H */
  53 #    elif defined(HAVE_GSSAPI_GSSAPI_H)
  54 #      include <gssapi/gssapi.h>
  55 #      ifdef HAVE_GSSAPI_GENERIC_H
  56 #        include <gssapi/gssapi_generic.h>
  57 #      endif /* HAVE_GSSAPI_GENERIC_H */
  58 #      ifdef HAVE_GSSAPI_KRB5_H
  59 #        include <gssapi/gssapi_krb5.h>
  60 #      endif /* HAVE_GSSAPI_KRB5_H */
  61 #    elif defined(HAVE_GSSAPI_H)
  62 #      include <gssapi.h>
  63 #    endif /* HAVE_GSS_GSSAPI_H */
  64 #    ifndef HAVE_GSS_C_NT_HOSTBASED_SERVICE
  65 #      define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
  66 #    endif /* !HAVE_GSS_C_NT_HOSTBASED_SERVICE */
  67 #    ifdef HAVE_KRB5_H
  68 #      include <krb5.h>
  69 #    endif /* HAVE_KRB5_H */
  70 #  endif /* HAVE_GSSAPI */
  71
  72 #  ifdef HAVE_AUTHORIZATION_H
  73 #    include <Security/Authorization.h>
  74 #  endif /* HAVE_AUTHORIZATION_H */
  75
  76 #  if defined(__sgi) || (defined(__APPLE__) && !defined(_SOCKLEN_T))
  77 /*
  78  * IRIX and MacOS X 10.2.x do not define socklen_t, and in fact use an int instead of
  79  * unsigned type for length values...
  80  */
  81
  82 typedef int socklen_t;
  83 #  endif /* __sgi || (__APPLE__ && !_SOCKLEN_T) */
  84
  85 #  include <cups/http.h>
  86 #  include "md5-private.h"
  87 #  include "ipp-private.h"
  88
  89 #  if defined HAVE_LIBSSL
  90 #    include <openssl/err.h>
  91 #    include <openssl/rand.h>
  92 #    include <openssl/ssl.h>
  93 #  elif defined HAVE_GNUTLS
  94 #    include <gnutls/gnutls.h>
  95 #    include <gnutls/x509.h>
  96 #    include <gcrypt.h>
  97 #  elif defined(HAVE_CDSASSL)
  98 #    include <CoreFoundation/CoreFoundation.h>
  99 #    include <Security/Security.h>
 100 #    include <Security/SecureTransport.h>
 101 #    ifdef HAVE_SECURETRANSPORTPRIV_H
 102 #      include <Security/SecureTransportPriv.h>
 103 #    endif /* HAVE_SECURETRANSPORTPRIV_H */
 104 #    ifdef HAVE_SECITEM_H
 105 #      include <Security/SecItem.h>
 106 #    endif /* HAVE_SECITEM_H */
 107 #    ifdef HAVE_SECBASEPRIV_H
 108 #      include <Security/SecBasePriv.h>
 109 #    endif /* HAVE_SECBASEPRIV_H */
 110 #    ifdef HAVE_SECCERTIFICATE_H
 111 #      include <Security/SecCertificate.h>
 112 #      include <Security/SecIdentity.h>
 113 #    endif /* HAVE_SECCERTIFICATE_H */
 114 #    ifdef HAVE_SECITEMPRIV_H
 115 #      include <Security/SecItemPriv.h>
 116 #    endif /* HAVE_SECITEMPRIV_H */
 117 #    ifdef HAVE_SECIDENTITYSEARCHPRIV_H
 118 #      include <Security/SecIdentitySearchPriv.h>
 119 #    endif /* HAVE_SECIDENTITYSEARCHPRIV_H */
 120 #    ifdef HAVE_SECPOLICYPRIV_H
 121 #      include <Security/SecPolicyPriv.h>
 122 #    endif /* HAVE_SECPOLICYPRIV_H */
 123 #  elif defined(HAVE_SSPISSL)
 124 #    include "sspi-private.h"
 125 #  endif /* HAVE_LIBSSL */
 126
 127 #  ifndef WIN32
 128 #    include <net/if.h>
 129 #    ifdef HAVE_GETIFADDRS
 130 #      include <ifaddrs.h>
 131 #    else
 132 #      include <sys/ioctl.h>
 133 #      ifdef HAVE_SYS_SOCKIO_H
 134 #        include <sys/sockio.h>
 135 #      endif /* HAVE_SYS_SOCKIO_H */
 136 #    endif /* HAVE_GETIFADDRS */
 137 #  endif /* !WIN32 */
 138
 139
 140 /*
 141  * C++ magic...
 142  */
 143
 144 #  ifdef __cplusplus
 145 extern "C" {
 146 #  endif /* __cplusplus */
 147
 148
 149 /*
 150  * Constants...
 151  */
 152
 153
 154 #define _HTTP_RESOLVE_DEFAULT   0       /* Just resolve with default options */
 155 #define _HTTP_RESOLVE_STDERR    1       /* Log resolve progress to stderr */
 156 #define _HTTP_RESOLVE_FQDN      2       /* Resolve to a FQDN */
 157
 158
 159 /*
 160  * Types and functions for SSL support...
 161  */
 162
 163 #  if defined HAVE_LIBSSL
 164 /*
 165  * The OpenSSL library provides its own SSL/TLS context structure for its
 166  * IO and protocol management.  However, we need to provide our own BIO
 167  * (basic IO) implementation to do timeouts...
 168  */
 169
 170 typedef SSL  *http_tls_t;
 171 typedef void *http_tls_credentials_t;
 172
 173 extern BIO_METHOD *_httpBIOMethods(void);
 174
 175 #  elif defined HAVE_GNUTLS
 176 /*
 177  * The GNU TLS library is more of a "bare metal" SSL/TLS library...
 178  */
 179
 180 typedef gnutls_session http_tls_t;
 181 typedef void *http_tls_credentials_t;
 182
 183 extern ssize_t  _httpReadGNUTLS(gnutls_transport_ptr ptr, void *data,
 184                                 size_t length);
 185 extern ssize_t  _httpWriteGNUTLS(gnutls_transport_ptr ptr, const void *data,
 186                                  size_t length);
 187
 188 #  elif defined(HAVE_CDSASSL)
 189 /*
 190  * Darwin's Security framework provides its own SSL/TLS context structure
 191  * for its IO and protocol management...
 192  */
 193
 194 #    if !defined(HAVE_SECBASEPRIV_H) && defined(HAVE_CSSMERRORSTRING) /* Declare prototype for function in that header... */
 195 extern const char *cssmErrorString(int error);
 196 #    endif /* !HAVE_SECBASEPRIV_H && HAVE_CSSMERRORSTRING */
 197 #    ifndef HAVE_SECITEMPRIV_H /* Declare constants from that header... */
 198 extern const CFTypeRef kSecClassCertificate;
 199 extern const CFTypeRef kSecClassIdentity;
 200 #    endif /* !HAVE_SECITEMPRIV_H */
 201 #    if !defined(HAVE_SECIDENTITYSEARCHPRIV_H) && defined(HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY) /* Declare prototype for function in that header... */
 202 extern OSStatus SecIdentitySearchCreateWithPolicy(SecPolicyRef policy,
 203                                 CFStringRef idString, CSSM_KEYUSE keyUsage,
 204                                 CFTypeRef keychainOrArray,
 205                                 Boolean returnOnlyValidIdentities,
 206                                 SecIdentitySearchRef* searchRef);
 207 #    endif /* !HAVE_SECIDENTITYSEARCHPRIV_H && HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY */
 208 #    if !defined(HAVE_SECPOLICYPRIV_H) && defined(HAVE_SECPOLICYSETVALUE) /* Declare prototype for function in that header... */
 209 extern OSStatus SecPolicySetValue(SecPolicyRef policyRef,
 210                                   const CSSM_DATA *value);
 211 #    endif /* !HAVE_SECPOLICYPRIV_H && HAVE_SECPOLICYSETVALUE */
 212
 213 typedef SSLContextRef   http_tls_t;
 214 typedef CFArrayRef      http_tls_credentials_t;
 215
 216 extern OSStatus _httpReadCDSA(SSLConnectionRef connection, void *data,
 217                               size_t *dataLength);
 218 extern OSStatus _httpWriteCDSA(SSLConnectionRef connection, const void *data,
 219                                size_t *dataLength);
 220
 221 #  elif defined(HAVE_SSPISSL)
 222 /*
 223  * Windows' SSPI library gets a CUPS wrapper...
 224  */
 225
 226 typedef _sspi_struct_t * http_tls_t;
 227 typedef void *http_tls_credentials_t;
 228
 229 #  else
 230 /*
 231  * Otherwise define stub types since we have no SSL support...
 232  */
 233
 234 typedef void *http_tls_t;
 235 typedef void *http_tls_credentials_t;
 236 #  endif /* HAVE_LIBSSL */
 237
 238 struct _http_s                          /**** HTTP connection structure. ****/
 239 {
 240   int                   fd;             /* File descriptor for this socket */
 241   int                   blocking;       /* To block or not to block */
 242   int                   error;          /* Last error on read */
 243   time_t                activity;       /* Time since last read/write */
 244   http_state_t          state;          /* State of client */
 245   http_status_t         status;         /* Status of last request */
 246   http_version_t        version;        /* Protocol version */
 247   http_keepalive_t      keep_alive;     /* Keep-alive supported? */
 248   struct sockaddr_in    _hostaddr;      /* Address of connected host @deprecated@ */
 249   char                  hostname[HTTP_MAX_HOST],
 250                                         /* Name of connected host */
 251                         fields[HTTP_FIELD_MAX][HTTP_MAX_VALUE];
 252                                         /* Field values */
 253   char                  *data;          /* Pointer to data buffer */
 254   http_encoding_t       data_encoding;  /* Chunked or not */
 255   int                   _data_remaining;/* Number of bytes left @deprecated@ */
 256   int                   used;           /* Number of bytes used in buffer */
 257   char                  buffer[HTTP_MAX_BUFFER];
 258                                         /* Buffer for incoming data */
 259   int                   auth_type;      /* Authentication in use */
 260   _cups_md5_state_t     md5_state;      /* MD5 state */
 261   char                  nonce[HTTP_MAX_VALUE];
 262                                         /* Nonce value */
 263   int                   nonce_count;    /* Nonce count */
 264   http_tls_t            tls;            /* TLS state information */
 265   http_encryption_t     encryption;     /* Encryption requirements */
 266   /**** New in CUPS 1.1.19 ****/
 267   fd_set                *input_set;     /* select() set for httpWait() @deprecated@ */
 268   http_status_t         expect;         /* Expect: header @since CUPS 1.1.19@ */
 269   char                  *cookie;        /* Cookie value(s) @since CUPS 1.1.19@ */
 270   /**** New in CUPS 1.1.20 ****/
 271   char                  _authstring[HTTP_MAX_VALUE],
 272                                         /* Current Authentication value. @deprecated@ */
 273                         userpass[HTTP_MAX_VALUE];
 274                                         /* Username:password string @since CUPS 1.1.20@ */
 275   int                   digest_tries;   /* Number of tries for digest auth @since CUPS 1.1.20@ */
 276   /**** New in CUPS 1.2 ****/
 277   off_t                 data_remaining; /* Number of bytes left @since CUPS 1.2@ */
 278   http_addr_t           *hostaddr;      /* Current host address and port @since CUPS 1.2@ */
 279   http_addrlist_t       *addrlist;      /* List of valid addresses @since CUPS 1.2@ */
 280   char                  wbuffer[HTTP_MAX_BUFFER];
 281                                         /* Buffer for outgoing data */
 282   int                   wused;          /* Write buffer bytes used @since CUPS 1.2@ */
 283   /**** New in CUPS 1.3 ****/
 284   char                  *field_authorization;
 285                                         /* Authorization field @since CUPS 1.3@ */
 286   char                  *authstring;    /* Current authorization field @since CUPS 1.3 */
 287 #  ifdef HAVE_GSSAPI
 288   gss_OID               gssmech;        /* Authentication mechanism @since CUPS 1.3@ */
 289   gss_ctx_id_t          gssctx;         /* Authentication context @since CUPS 1.3@ */
 290   gss_name_t            gssname;        /* Authentication server name @since CUPS 1.3@ */
 291 #  endif /* HAVE_GSSAPI */
 292 #  ifdef HAVE_AUTHORIZATION_H
 293   AuthorizationRef      auth_ref;       /* Authorization ref @since CUPS 1.3@ */
 294 #  endif /* HAVE_AUTHORIZATION_H */
 295   /**** New in CUPS 1.5 ****/
 296   http_tls_credentials_t tls_credentials;
 297                                         /* TLS credentials @since CUPS 1.5/Mac OS X 10.7@ */
 298   http_timeout_cb_t     timeout_cb;     /* Timeout callback @since CUPS 1.5/Mac OS X 10.7@ */
 299   void                  *timeout_data;  /* User data pointer @since CUPS 1.5/Mac OS X 10.7@ */
 300   struct timeval        timeout_value;  /* Timeout in seconds */
 301 #  ifdef HAVE_GSSAPI
 302   char                  gsshost[256];   /* Hostname for Kerberos */
 303 #  endif /* HAVE_GSSAPI */
 304 };
 305
 306
 307 /*
 308  * Some OS's don't have hstrerror(), most notably Solaris...
 309  */
 310
 311 #  ifndef HAVE_HSTRERROR
 312 extern const char *_cups_hstrerror(int error);
 313 #    define hstrerror _cups_hstrerror
 314 #  elif defined(_AIX) || defined(__osf__)
 315 /*
 316  * AIX and Tru64 UNIX don't provide a prototype but do provide the function...
 317  */
 318 extern const char *hstrerror(int error);
 319 #  endif /* !HAVE_HSTRERROR */
 320
 321
 322 /*
 323  * Some OS's don't have getifaddrs() and freeifaddrs()...
 324  */
 325
 326 #  if !defined(WIN32) && !defined(HAVE_GETIFADDRS)
 327 #    ifdef ifa_dstaddr
 328 #      undef ifa_dstaddr
 329 #    endif /* ifa_dstaddr */
 330 #    ifndef ifr_netmask
 331 #      define ifr_netmask ifr_addr
 332 #    endif /* !ifr_netmask */
 333
 334 struct ifaddrs                          /**** Interface Structure ****/
 335 {
 336   struct ifaddrs        *ifa_next;      /* Next interface in list */
 337   char                  *ifa_name;      /* Name of interface */
 338   unsigned int          ifa_flags;      /* Flags (up, point-to-point, etc.) */
 339   struct sockaddr       *ifa_addr,      /* Network address */
 340                         *ifa_netmask;   /* Address mask */
 341   union
 342   {
 343     struct sockaddr     *ifu_broadaddr; /* Broadcast address of this interface. */
 344     struct sockaddr     *ifu_dstaddr;   /* Point-to-point destination address. */
 345   } ifa_ifu;
 346
 347   void                  *ifa_data;      /* Interface statistics */
 348 };
 349
 350 #    ifndef ifa_broadaddr
 351 #      define ifa_broadaddr ifa_ifu.ifu_broadaddr
 352 #    endif /* !ifa_broadaddr */
 353 #    ifndef ifa_dstaddr
 354 #      define ifa_dstaddr ifa_ifu.ifu_dstaddr
 355 #    endif /* !ifa_dstaddr */
 356
 357 extern int      _cups_getifaddrs(struct ifaddrs **addrs);
 358 #    define getifaddrs _cups_getifaddrs
 359 extern void     _cups_freeifaddrs(struct ifaddrs *addrs);
 360 #    define freeifaddrs _cups_freeifaddrs
 361 #  endif /* !WIN32 && !HAVE_GETIFADDRS */
 362
 363
 364 /*
 365  * Prototypes...
 366  */
 367
 368 #define                 _httpAddrFamily(addrp) (addrp)->addr.sa_family
 369 extern int              _httpAddrPort(http_addr_t *addr);
 370 extern void             _httpAddrSetPort(http_addr_t *addr, int port);
 371 extern char             *_httpAssembleUUID(const char *server, int port,
 372                                            const char *name, int number,
 373                                            char *buffer, size_t bufsize);
 374 extern http_tls_credentials_t
 375                         _httpConvertCredentials(cups_array_t *credentials);
 376 extern http_t           *_httpCreate(const char *host, int port,
 377                                      http_addrlist_t *addrlist,
 378                                      http_encryption_t encryption,
 379                                      int family);
 380 extern char             *_httpDecodeURI(char *dst, const char *src,
 381                                         size_t dstsize);
 382 extern void             _httpDisconnect(http_t *http);
 383 extern char             *_httpEncodeURI(char *dst, const char *src,
 384                                         size_t dstsize);
 385 extern void             _httpFreeCredentials(http_tls_credentials_t credentials);
 386 extern ssize_t          _httpPeek(http_t *http, char *buffer, size_t length);
 387 extern const char       *_httpResolveURI(const char *uri, char *resolved_uri,
 388                                          size_t resolved_size, int options,
 389                                          int (*cb)(void *context),
 390                                          void *context);
 391 extern int              _httpUpdate(http_t *http, http_status_t *status);
 392 extern int              _httpWait(http_t *http, int msec, int usessl);
 393
 394
 395 /*
 396  * C++ magic...
 397  */
 398
 399 #  ifdef __cplusplus
 400 }
 401 #  endif /* __cplusplus */
 402
 403 #endif /* !_CUPS_HTTP_PRIVATE_H_ */
 404
 405 /*
 406  * End of "$Id: http-private.h 7850 2008-08-20 00:07:25Z mike $".
 407  */