cups/http-private.h

   1 /*
   2  * "$Id$"
   3  *
   4  *   Private HTTP definitions for CUPS.
   5  *
   6  *   Copyright 2007-2012 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(__APPLE__) && !defined(_SOCKLEN_T)
  77 /*
  78  * MacOS X 10.2.x does not define socklen_t, and in fact uses an int instead of
  79  * unsigned type for length values...
  80  */
  81
  82 typedef int socklen_t;
  83 #  endif /* __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 #  ifdef HAVE_LIBZ
 140 #    include <zlib.h>
 141 #  endif /* HAVE_LIBZ */
 142
 143
 144 /*
 145  * C++ magic...
 146  */
 147
 148 #  ifdef __cplusplus
 149 extern "C" {
 150 #  endif /* __cplusplus */
 151
 152
 153 /*
 154  * Constants...
 155  */
 156
 157
 158 #define _HTTP_RESOLVE_DEFAULT   0       /* Just resolve with default options */
 159 #define _HTTP_RESOLVE_STDERR    1       /* Log resolve progress to stderr */
 160 #define _HTTP_RESOLVE_FQDN      2       /* Resolve to a FQDN */
 161 #define _HTTP_RESOLVE_FAXOUT    4       /* Resolve FaxOut service? */
 162
 163
 164 /*
 165  * Types and functions for SSL support...
 166  */
 167
 168 #  if defined HAVE_LIBSSL
 169 /*
 170  * The OpenSSL library provides its own SSL/TLS context structure for its
 171  * IO and protocol management.  However, we need to provide our own BIO
 172  * (basic IO) implementation to do timeouts...
 173  */
 174
 175 typedef SSL  *http_tls_t;
 176 typedef void *http_tls_credentials_t;
 177
 178 extern BIO_METHOD *_httpBIOMethods(void);
 179
 180 #  elif defined HAVE_GNUTLS
 181 /*
 182  * The GNU TLS library is more of a "bare metal" SSL/TLS library...
 183  */
 184
 185 typedef gnutls_session http_tls_t;
 186 typedef void *http_tls_credentials_t;
 187
 188 extern ssize_t  _httpReadGNUTLS(gnutls_transport_ptr ptr, void *data,
 189                                 size_t length);
 190 extern ssize_t  _httpWriteGNUTLS(gnutls_transport_ptr ptr, const void *data,
 191                                  size_t length);
 192
 193 #  elif defined(HAVE_CDSASSL)
 194 /*
 195  * Darwin's Security framework provides its own SSL/TLS context structure
 196  * for its IO and protocol management...
 197  */
 198
 199 #    if !defined(HAVE_SECBASEPRIV_H) && defined(HAVE_CSSMERRORSTRING) /* Declare prototype for function in that header... */
 200 extern const char *cssmErrorString(int error);
 201 #    endif /* !HAVE_SECBASEPRIV_H && HAVE_CSSMERRORSTRING */
 202 #    ifndef HAVE_SECITEMPRIV_H /* Declare constants from that header... */
 203 extern const CFTypeRef kSecClassCertificate;
 204 extern const CFTypeRef kSecClassIdentity;
 205 #    endif /* !HAVE_SECITEMPRIV_H */
 206 #    if !defined(HAVE_SECIDENTITYSEARCHPRIV_H) && defined(HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY) /* Declare prototype for function in that header... */
 207 extern OSStatus SecIdentitySearchCreateWithPolicy(SecPolicyRef policy,
 208                                 CFStringRef idString, CSSM_KEYUSE keyUsage,
 209                                 CFTypeRef keychainOrArray,
 210                                 Boolean returnOnlyValidIdentities,
 211                                 SecIdentitySearchRef* searchRef);
 212 #    endif /* !HAVE_SECIDENTITYSEARCHPRIV_H && HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY */
 213 #    if !defined(HAVE_SECPOLICYPRIV_H) && defined(HAVE_SECPOLICYSETVALUE) /* Declare prototype for function in that header... */
 214 extern OSStatus SecPolicySetValue(SecPolicyRef policyRef,
 215                                   const CSSM_DATA *value);
 216 #    endif /* !HAVE_SECPOLICYPRIV_H && HAVE_SECPOLICYSETVALUE */
 217
 218 typedef SSLContextRef   http_tls_t;
 219 typedef CFArrayRef      http_tls_credentials_t;
 220
 221 extern OSStatus _httpReadCDSA(SSLConnectionRef connection, void *data,
 222                               size_t *dataLength);
 223 extern OSStatus _httpWriteCDSA(SSLConnectionRef connection, const void *data,
 224                                size_t *dataLength);
 225
 226 #  elif defined(HAVE_SSPISSL)
 227 /*
 228  * Windows' SSPI library gets a CUPS wrapper...
 229  */
 230
 231 typedef _sspi_struct_t * http_tls_t;
 232 typedef void *http_tls_credentials_t;
 233
 234 #  else
 235 /*
 236  * Otherwise define stub types since we have no SSL support...
 237  */
 238
 239 typedef void *http_tls_t;
 240 typedef void *http_tls_credentials_t;
 241 #  endif /* HAVE_LIBSSL */
 242
 243 typedef enum _http_coding_e             /**** HTTP content coding enumeration ****/
 244 {
 245   _HTTP_CODING_IDENTITY,                /* No content coding */
 246   _HTTP_CODING_GZIP,                    /* LZ77+gzip decompression */
 247   _HTTP_CODING_DEFLATE,                 /* LZ77+zlib compression */
 248   _HTTP_CODING_GUNZIP,                  /* LZ77+gzip decompression */
 249   _HTTP_CODING_INFLATE                  /* LZ77+zlib decompression */
 250 } _http_coding_t;
 251
 252 typedef enum _http_mode_e               /**** HTTP mode enumeration ****/
 253 {
 254   _HTTP_MODE_CLIENT,                    /* Client connected to server */
 255   _HTTP_MODE_SERVER                     /* Server connected (accepted) from client */
 256 } _http_mode_t;
 257
 258 struct _http_s                          /**** HTTP connection structure ****/
 259 {
 260   int                   fd;             /* File descriptor for this socket */
 261   int                   blocking;       /* To block or not to block */
 262   int                   error;          /* Last error on read */
 263   time_t                activity;       /* Time since last read/write */
 264   http_state_t          state;          /* State of client */
 265   http_status_t         status;         /* Status of last request */
 266   http_version_t        version;        /* Protocol version */
 267   http_keepalive_t      keep_alive;     /* Keep-alive supported? */
 268   struct sockaddr_in    _hostaddr;      /* Address of connected host (deprecated) */
 269   char                  hostname[HTTP_MAX_HOST],
 270                                         /* Name of connected host */
 271                         fields[HTTP_FIELD_ACCEPT_ENCODING][HTTP_MAX_VALUE];
 272                                         /* Field values up to Accept-Encoding */
 273   char                  *data;          /* Pointer to data buffer */
 274   http_encoding_t       data_encoding;  /* Chunked or not */
 275   int                   _data_remaining;/* Number of bytes left (deprecated) */
 276   int                   used;           /* Number of bytes used in buffer */
 277   char                  buffer[HTTP_MAX_BUFFER];
 278                                         /* Buffer for incoming data */
 279   int                   auth_type;      /* Authentication in use */
 280   _cups_md5_state_t     md5_state;      /* MD5 state */
 281   char                  nonce[HTTP_MAX_VALUE];
 282                                         /* Nonce value */
 283   int                   nonce_count;    /* Nonce count */
 284   http_tls_t            tls;            /* TLS state information */
 285   http_encryption_t     encryption;     /* Encryption requirements */
 286
 287   /**** New in CUPS 1.1.19 ****/
 288   fd_set                *input_set;     /* select() set for httpWait() (deprecated) */
 289   http_status_t         expect;         /* Expect: header */
 290   char                  *cookie;        /* Cookie value(s) */
 291
 292   /**** New in CUPS 1.1.20 ****/
 293   char                  _authstring[HTTP_MAX_VALUE],
 294                                         /* Current Authentication value (deprecated) */
 295                         userpass[HTTP_MAX_VALUE];
 296                                         /* Username:password string */
 297   int                   digest_tries;   /* Number of tries for digest auth */
 298
 299   /**** New in CUPS 1.2 ****/
 300   off_t                 data_remaining; /* Number of bytes left */
 301   http_addr_t           *hostaddr;      /* Current host address and port */
 302   http_addrlist_t       *addrlist;      /* List of valid addresses */
 303   char                  wbuffer[HTTP_MAX_BUFFER];
 304                                         /* Buffer for outgoing data */
 305   int                   wused;          /* Write buffer bytes used */
 306
 307   /**** New in CUPS 1.3 ****/
 308   char                  *field_authorization;
 309                                         /* Authorization field */
 310   char                  *authstring;    /* Current authorization field */
 311 #  ifdef HAVE_GSSAPI
 312   gss_OID               gssmech;        /* Authentication mechanism */
 313   gss_ctx_id_t          gssctx;         /* Authentication context */
 314   gss_name_t            gssname;        /* Authentication server name */
 315 #  endif /* HAVE_GSSAPI */
 316 #  ifdef HAVE_AUTHORIZATION_H
 317   AuthorizationRef      auth_ref;       /* Authorization ref */
 318 #  endif /* HAVE_AUTHORIZATION_H */
 319
 320   /**** New in CUPS 1.5 ****/
 321   http_tls_credentials_t tls_credentials;
 322                                         /* TLS credentials */
 323   http_timeout_cb_t     timeout_cb;     /* Timeout callback */
 324   void                  *timeout_data;  /* User data pointer */
 325   double                timeout_value;  /* Timeout in seconds */
 326   int                   wait_value;     /* httpWait value for timeout */
 327 #  ifdef HAVE_GSSAPI
 328   char                  gsshost[256];   /* Hostname for Kerberos */
 329 #  endif /* HAVE_GSSAPI */
 330
 331   /**** New in CUPS 1.7 ****/
 332   _http_mode_t          mode;           /* _HTTP_MODE_CLIENT or _HTTP_MODE_SERVER */
 333   char                  *accept_encoding,
 334                                         /* Accept-Encoding field */
 335                         *allow,         /* Allow field */
 336                         *server;        /* Server field */
 337 #  ifdef HAVE_LIBZ
 338   _http_coding_t        coding;         /* _HTTP_CODING_xxx */
 339   z_stream              stream;         /* (De)compression stream */
 340 #  endif /* HAVE_LIBZ */
 341 };
 342
 343
 344 /*
 345  * Some OS's don't have hstrerror(), most notably Solaris...
 346  */
 347
 348 #  ifndef HAVE_HSTRERROR
 349 extern const char *_cups_hstrerror(int error);
 350 #    define hstrerror _cups_hstrerror
 351 #  elif defined(_AIX) || defined(__osf__)
 352 /*
 353  * AIX and Tru64 UNIX don't provide a prototype but do provide the function...
 354  */
 355 extern const char *hstrerror(int error);
 356 #  endif /* !HAVE_HSTRERROR */
 357
 358
 359 /*
 360  * Some OS's don't have getifaddrs() and freeifaddrs()...
 361  */
 362
 363 #  if !defined(WIN32) && !defined(HAVE_GETIFADDRS)
 364 #    ifdef ifa_dstaddr
 365 #      undef ifa_dstaddr
 366 #    endif /* ifa_dstaddr */
 367 #    ifndef ifr_netmask
 368 #      define ifr_netmask ifr_addr
 369 #    endif /* !ifr_netmask */
 370
 371 struct ifaddrs                          /**** Interface Structure ****/
 372 {
 373   struct ifaddrs        *ifa_next;      /* Next interface in list */
 374   char                  *ifa_name;      /* Name of interface */
 375   unsigned int          ifa_flags;      /* Flags (up, point-to-point, etc.) */
 376   struct sockaddr       *ifa_addr,      /* Network address */
 377                         *ifa_netmask;   /* Address mask */
 378   union
 379   {
 380     struct sockaddr     *ifu_broadaddr; /* Broadcast address of this interface. */
 381     struct sockaddr     *ifu_dstaddr;   /* Point-to-point destination address. */
 382   } ifa_ifu;
 383
 384   void                  *ifa_data;      /* Interface statistics */
 385 };
 386
 387 #    ifndef ifa_broadaddr
 388 #      define ifa_broadaddr ifa_ifu.ifu_broadaddr
 389 #    endif /* !ifa_broadaddr */
 390 #    ifndef ifa_dstaddr
 391 #      define ifa_dstaddr ifa_ifu.ifu_dstaddr
 392 #    endif /* !ifa_dstaddr */
 393
 394 extern int      _cups_getifaddrs(struct ifaddrs **addrs);
 395 #    define getifaddrs _cups_getifaddrs
 396 extern void     _cups_freeifaddrs(struct ifaddrs *addrs);
 397 #    define freeifaddrs _cups_freeifaddrs
 398 #  endif /* !WIN32 && !HAVE_GETIFADDRS */
 399
 400
 401 /*
 402  * Prototypes...
 403  */
 404
 405 #define                 _httpAddrFamily(addrp) (addrp)->addr.sa_family
 406 extern void             _httpAddrSetPort(http_addr_t *addr, int port);
 407 extern char             *_httpAssembleUUID(const char *server, int port,
 408                                            const char *name, int number,
 409                                            char *buffer, size_t bufsize);
 410 extern http_t           *_httpCreate(const char *host, int port,
 411                                      http_addrlist_t *addrlist, int family,
 412                                      http_encryption_t encryption,
 413                                      int blocking, _http_mode_t mode);
 414 extern http_tls_credentials_t
 415                         _httpCreateCredentials(cups_array_t *credentials);
 416 extern char             *_httpDecodeURI(char *dst, const char *src,
 417                                         size_t dstsize);
 418 extern void             _httpDisconnect(http_t *http);
 419 extern char             *_httpEncodeURI(char *dst, const char *src,
 420                                         size_t dstsize);
 421 extern void             _httpFreeCredentials(http_tls_credentials_t credentials);
 422 extern const char       *_httpResolveURI(const char *uri, char *resolved_uri,
 423                                          size_t resolved_size, int options,
 424                                          int (*cb)(void *context),
 425                                          void *context);
 426 extern int              _httpUpdate(http_t *http, http_status_t *status);
 427 extern int              _httpWait(http_t *http, int msec, int usessl);
 428
 429
 430 /*
 431  * C++ magic...
 432  */
 433
 434 #  ifdef __cplusplus
 435 }
 436 #  endif /* __cplusplus */
 437
 438 #endif /* !_CUPS_HTTP_PRIVATE_H_ */
 439
 440 /*
 441  * End of "$Id$".
 442  */