cups/http-private.h

   1 /*
   2  * Private HTTP definitions for CUPS.
   3  *
   4  * Copyright 2007-2017 by Apple Inc.
   5  * Copyright 1997-2007 by Easy Software Products, all rights reserved.
   6  *
   7  * These coded instructions, statements, and computer programs are the
   8  * property of Apple Inc. and are protected by Federal copyright
   9  * law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  10  * which should have been included with this file.  If this file is
  11  * missing or damaged, see the license at "http://www.cups.org/".
  12  *
  13  * This file is subject to the Apple OS-Developed Software exception.
  14  */
  15
  16 #ifndef _CUPS_HTTP_PRIVATE_H_
  17 #  define _CUPS_HTTP_PRIVATE_H_
  18
  19 /*
  20  * Include necessary headers...
  21  */
  22
  23 #  include "config.h"
  24 #  include <cups/language.h>
  25 #  include <stddef.h>
  26 #  include <stdlib.h>
  27
  28 #  ifdef __sun
  29 #    include <sys/select.h>
  30 #  endif /* __sun */
  31
  32 #  include <limits.h>
  33 #  ifdef WIN32
  34 #    include <io.h>
  35 #    include <winsock2.h>
  36 #    define CUPS_SOCAST (const char *)
  37 #  else
  38 #    include <unistd.h>
  39 #    include <fcntl.h>
  40 #    include <sys/socket.h>
  41 #    define CUPS_SOCAST
  42 #  endif /* WIN32 */
  43
  44 #  ifdef HAVE_GSSAPI
  45 #    ifdef HAVE_GSS_GSSAPI_H
  46 #      include <GSS/gssapi.h>
  47 #    elif defined(HAVE_GSSAPI_GSSAPI_H)
  48 #      include <gssapi/gssapi.h>
  49 #    elif defined(HAVE_GSSAPI_H)
  50 #      include <gssapi.h>
  51 #    endif /* HAVE_GSS_GSSAPI_H */
  52 #    ifndef HAVE_GSS_C_NT_HOSTBASED_SERVICE
  53 #      define GSS_C_NT_HOSTBASED_SERVICE gss_nt_service_name
  54 #    endif /* !HAVE_GSS_C_NT_HOSTBASED_SERVICE */
  55 #  endif /* HAVE_GSSAPI */
  56
  57 #  ifdef HAVE_AUTHORIZATION_H
  58 #    include <Security/Authorization.h>
  59 #  endif /* HAVE_AUTHORIZATION_H */
  60
  61 #  if defined(__APPLE__) && !defined(_SOCKLEN_T)
  62 /*
  63  * macOS 10.2.x does not define socklen_t, and in fact uses an int instead of
  64  * unsigned type for length values...
  65  */
  66
  67 typedef int socklen_t;
  68 #  endif /* __APPLE__ && !_SOCKLEN_T */
  69
  70 #  include <cups/http.h>
  71 #  include "md5-private.h"
  72 #  include "ipp-private.h"
  73
  74 #  ifdef HAVE_GNUTLS
  75 #    include <gnutls/gnutls.h>
  76 #    include <gnutls/x509.h>
  77 #  elif defined(HAVE_CDSASSL)
  78 #    include <CoreFoundation/CoreFoundation.h>
  79 #    include <Security/Security.h>
  80 #    include <Security/SecureTransport.h>
  81 #    ifdef HAVE_SECURETRANSPORTPRIV_H
  82 #      include <Security/SecureTransportPriv.h>
  83 #    endif /* HAVE_SECURETRANSPORTPRIV_H */
  84 #    ifdef HAVE_SECITEM_H
  85 #      include <Security/SecItem.h>
  86 #    endif /* HAVE_SECITEM_H */
  87 #    ifdef HAVE_SECBASEPRIV_H
  88 #      include <Security/SecBasePriv.h>
  89 #    endif /* HAVE_SECBASEPRIV_H */
  90 #    ifdef HAVE_SECCERTIFICATE_H
  91 #      include <Security/SecCertificate.h>
  92 #      include <Security/SecIdentity.h>
  93 #    endif /* HAVE_SECCERTIFICATE_H */
  94 #    ifdef HAVE_SECCERTIFICATEPRIV_H
  95 #      include <Security/SecCertificatePriv.h>
  96 #    else
  97 #      ifdef __cplusplus
  98 extern "C" {
  99 #      endif /* __cplusplus */
 100 #      ifndef _SECURITY_VERSION_GREATER_THAN_57610_
 101 typedef CF_OPTIONS(uint32_t, SecKeyUsage) {
 102     kSecKeyUsageAll              = 0x7FFFFFFF
 103 };
 104 #       endif /* !_SECURITY_VERSION_GREATER_THAN_57610_ */
 105 extern const void * kSecCSRChallengePassword;
 106 extern const void * kSecSubjectAltName;
 107 extern const void * kSecCertificateKeyUsage;
 108 extern const void * kSecCSRBasicContraintsPathLen;
 109 extern const void * kSecCertificateExtensions;
 110 extern const void * kSecCertificateExtensionsEncoded;
 111 extern const void * kSecOidCommonName;
 112 extern const void * kSecOidCountryName;
 113 extern const void * kSecOidStateProvinceName;
 114 extern const void * kSecOidLocalityName;
 115 extern const void * kSecOidOrganization;
 116 extern const void * kSecOidOrganizationalUnit;
 117 extern SecCertificateRef SecCertificateCreateWithBytes(CFAllocatorRef allocator, const UInt8 *bytes, CFIndex length);
 118 extern bool SecCertificateIsValid(SecCertificateRef certificate, CFAbsoluteTime verifyTime);
 119 extern CFAbsoluteTime SecCertificateNotValidAfter(SecCertificateRef certificate);
 120 extern SecCertificateRef SecGenerateSelfSignedCertificate(CFArrayRef subject, CFDictionaryRef parameters, SecKeyRef publicKey, SecKeyRef privateKey);
 121 extern SecIdentityRef SecIdentityCreate(CFAllocatorRef allocator, SecCertificateRef certificate, SecKeyRef privateKey);
 122 #      ifdef __cplusplus
 123 }
 124 #      endif /* __cplusplus */
 125 #    endif /* HAVE_SECCERTIFICATEPRIV_H */
 126 #    ifdef HAVE_SECITEMPRIV_H
 127 #      include <Security/SecItemPriv.h>
 128 #    endif /* HAVE_SECITEMPRIV_H */
 129 #    ifdef HAVE_SECIDENTITYSEARCHPRIV_H
 130 #      include <Security/SecIdentitySearchPriv.h>
 131 #    endif /* HAVE_SECIDENTITYSEARCHPRIV_H */
 132 #    ifdef HAVE_SECPOLICYPRIV_H
 133 #      include <Security/SecPolicyPriv.h>
 134 #    endif /* HAVE_SECPOLICYPRIV_H */
 135 #  elif defined(HAVE_SSPISSL)
 136 #    include <wincrypt.h>
 137 #    include <wintrust.h>
 138 #    include <schannel.h>
 139 #    define SECURITY_WIN32
 140 #    include <security.h>
 141 #    include <sspi.h>
 142 #  endif /* HAVE_GNUTLS */
 143
 144 #  ifndef WIN32
 145 #    include <net/if.h>
 146 #    include <resolv.h>
 147 #    ifdef HAVE_GETIFADDRS
 148 #      include <ifaddrs.h>
 149 #    else
 150 #      include <sys/ioctl.h>
 151 #      ifdef HAVE_SYS_SOCKIO_H
 152 #        include <sys/sockio.h>
 153 #      endif /* HAVE_SYS_SOCKIO_H */
 154 #    endif /* HAVE_GETIFADDRS */
 155 #  endif /* !WIN32 */
 156
 157 #  ifdef HAVE_LIBZ
 158 #    include <zlib.h>
 159 #  endif /* HAVE_LIBZ */
 160
 161
 162 /*
 163  * C++ magic...
 164  */
 165
 166 #  ifdef __cplusplus
 167 extern "C" {
 168 #  endif /* __cplusplus */
 169
 170
 171 /*
 172  * Constants...
 173  */
 174
 175
 176 #define _HTTP_MAX_SBUFFER       65536   /* Size of (de)compression buffer */
 177 #define _HTTP_RESOLVE_DEFAULT   0       /* Just resolve with default options */
 178 #define _HTTP_RESOLVE_STDERR    1       /* Log resolve progress to stderr */
 179 #define _HTTP_RESOLVE_FQDN      2       /* Resolve to a FQDN */
 180 #define _HTTP_RESOLVE_FAXOUT    4       /* Resolve FaxOut service? */
 181
 182 #define _HTTP_TLS_UNCHANGED     0   /* Don't change TLS options */
 183 #define _HTTP_TLS_NONE          1   /* No TLS options */
 184 #define _HTTP_TLS_ALLOW_RC4     2   /* Allow RC4 cipher suites */
 185 #define _HTTP_TLS_ALLOW_SSL3    4   /* Allow SSL 3.0 */
 186 #define _HTTP_TLS_ALLOW_DH      8   /* Allow DH/DHE key negotiation */
 187 #define _HTTP_TLS_DENY_TLS10    16  /* Deny TLS 1.0 */
 188 #define _HTTP_TLS_DENY_CBC      32  /* Deny CBC cipher suites */
 189 #define _HTTP_TLS_ONLY_TLS10    64  /* Only use TLS 1.0 */
 190
 191
 192 /*
 193  * Types and functions for SSL support...
 194  */
 195
 196 #  ifdef HAVE_GNUTLS
 197 /*
 198  * The GNU TLS library is more of a "bare metal" SSL/TLS library...
 199  */
 200
 201 typedef gnutls_session_t http_tls_t;
 202 typedef gnutls_certificate_credentials_t *http_tls_credentials_t;
 203
 204 #  elif defined(HAVE_CDSASSL)
 205 /*
 206  * Darwin's Security framework provides its own SSL/TLS context structure
 207  * for its IO and protocol management...
 208  */
 209
 210 #    if !defined(HAVE_SECBASEPRIV_H) && defined(HAVE_CSSMERRORSTRING) /* Declare prototype for function in that header... */
 211 extern const char *cssmErrorString(int error);
 212 #    endif /* !HAVE_SECBASEPRIV_H && HAVE_CSSMERRORSTRING */
 213 #    if !defined(HAVE_SECIDENTITYSEARCHPRIV_H) && defined(HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY) /* Declare prototype for function in that header... */
 214 extern OSStatus SecIdentitySearchCreateWithPolicy(SecPolicyRef policy,
 215                                 CFStringRef idString, CSSM_KEYUSE keyUsage,
 216                                 CFTypeRef keychainOrArray,
 217                                 Boolean returnOnlyValidIdentities,
 218                                 SecIdentitySearchRef* searchRef);
 219 #    endif /* !HAVE_SECIDENTITYSEARCHPRIV_H && HAVE_SECIDENTITYSEARCHCREATEWITHPOLICY */
 220 #    if !defined(HAVE_SECPOLICYPRIV_H) && defined(HAVE_SECPOLICYSETVALUE) /* Declare prototype for function in that header... */
 221 extern OSStatus SecPolicySetValue(SecPolicyRef policyRef,
 222                                   const CSSM_DATA *value);
 223 #    endif /* !HAVE_SECPOLICYPRIV_H && HAVE_SECPOLICYSETVALUE */
 224
 225 typedef SSLContextRef   http_tls_t;
 226 typedef CFArrayRef      http_tls_credentials_t;
 227
 228 #  elif defined(HAVE_SSPISSL)
 229 /*
 230  * Windows' SSPI library gets a CUPS wrapper...
 231  */
 232
 233 typedef struct _http_sspi_s             /**** SSPI/SSL data structure ****/
 234 {
 235   CredHandle    creds;                  /* Credentials */
 236   CtxtHandle    context;                /* SSL context */
 237   BOOL          contextInitialized;     /* Is context init'd? */
 238   SecPkgContext_StreamSizes streamSizes;/* SSL data stream sizes */
 239   BYTE          *decryptBuffer;         /* Data pre-decryption*/
 240   size_t        decryptBufferLength;    /* Length of decrypt buffer */
 241   size_t        decryptBufferUsed;      /* Bytes used in buffer */
 242   BYTE          *readBuffer;            /* Data post-decryption */
 243   int           readBufferLength;       /* Length of read buffer */
 244   int           readBufferUsed;         /* Bytes used in buffer */
 245   BYTE          *writeBuffer;           /* Data pre-encryption */
 246   int           writeBufferLength;      /* Length of write buffer */
 247   PCCERT_CONTEXT localCert,             /* Local certificate */
 248                 remoteCert;             /* Remote (peer's) certificate */
 249   char          error[256];             /* Most recent error message */
 250 } _http_sspi_t;
 251 typedef _http_sspi_t *http_tls_t;
 252 typedef PCCERT_CONTEXT http_tls_credentials_t;
 253
 254 #  else
 255 /*
 256  * Otherwise define stub types since we have no SSL support...
 257  */
 258
 259 typedef void *http_tls_t;
 260 typedef void *http_tls_credentials_t;
 261 #  endif /* HAVE_GNUTLS */
 262
 263 typedef enum _http_coding_e             /**** HTTP content coding enumeration ****/
 264 {
 265   _HTTP_CODING_IDENTITY,                /* No content coding */
 266   _HTTP_CODING_GZIP,                    /* LZ77+gzip decompression */
 267   _HTTP_CODING_DEFLATE,                 /* LZ77+zlib compression */
 268   _HTTP_CODING_GUNZIP,                  /* LZ77+gzip decompression */
 269   _HTTP_CODING_INFLATE                  /* LZ77+zlib decompression */
 270 } _http_coding_t;
 271
 272 typedef enum _http_mode_e               /**** HTTP mode enumeration ****/
 273 {
 274   _HTTP_MODE_CLIENT,                    /* Client connected to server */
 275   _HTTP_MODE_SERVER                     /* Server connected (accepted) from client */
 276 } _http_mode_t;
 277
 278 #  ifndef _HTTP_NO_PRIVATE
 279 struct _http_s                          /**** HTTP connection structure ****/
 280 {
 281   int                   fd;             /* File descriptor for this socket */
 282   int                   blocking;       /* To block or not to block */
 283   int                   error;          /* Last error on read */
 284   time_t                activity;       /* Time since last read/write */
 285   http_state_t          state;          /* State of client */
 286   http_status_t         status;         /* Status of last request */
 287   http_version_t        version;        /* Protocol version */
 288   http_keepalive_t      keep_alive;     /* Keep-alive supported? */
 289   struct sockaddr_in    _hostaddr;      /* Address of connected host (deprecated) */
 290   char                  hostname[HTTP_MAX_HOST],
 291                                         /* Name of connected host */
 292                         fields[HTTP_FIELD_ACCEPT_ENCODING][HTTP_MAX_VALUE];
 293                                         /* Field values up to Accept-Encoding */
 294   char                  *data;          /* Pointer to data buffer */
 295   http_encoding_t       data_encoding;  /* Chunked or not */
 296   int                   _data_remaining;/* Number of bytes left (deprecated) */
 297   int                   used;           /* Number of bytes used in buffer */
 298   char                  buffer[HTTP_MAX_BUFFER];
 299                                         /* Buffer for incoming data */
 300   int                   _auth_type;     /* Authentication in use (deprecated) */
 301   _cups_md5_state_t     md5_state;      /* MD5 state */
 302   char                  nonce[HTTP_MAX_VALUE];
 303                                         /* Nonce value */
 304   int                   nonce_count;    /* Nonce count */
 305   http_tls_t            tls;            /* TLS state information */
 306   http_encryption_t     encryption;     /* Encryption requirements */
 307
 308   /**** New in CUPS 1.1.19 ****/
 309   fd_set                *input_set;     /* select() set for httpWait() (deprecated) */
 310   http_status_t         expect;         /* Expect: header */
 311   char                  *cookie;        /* Cookie value(s) */
 312
 313   /**** New in CUPS 1.1.20 ****/
 314   char                  _authstring[HTTP_MAX_VALUE],
 315                                         /* Current Authorization value (deprecated) */
 316                         userpass[HTTP_MAX_VALUE];
 317                                         /* Username:password string */
 318   int                   digest_tries;   /* Number of tries for digest auth */
 319
 320   /**** New in CUPS 1.2 ****/
 321   off_t                 data_remaining; /* Number of bytes left */
 322   http_addr_t           *hostaddr;      /* Current host address and port */
 323   http_addrlist_t       *addrlist;      /* List of valid addresses */
 324   char                  wbuffer[HTTP_MAX_BUFFER];
 325                                         /* Buffer for outgoing data */
 326   int                   wused;          /* Write buffer bytes used */
 327
 328   /**** New in CUPS 1.3 ****/
 329   char                  *field_authorization;
 330                                         /* Authorization field */
 331   char                  *authstring;    /* Current Authorization field */
 332 #  ifdef HAVE_GSSAPI
 333   gss_OID               gssmech;        /* Authentication mechanism */
 334   gss_ctx_id_t          gssctx;         /* Authentication context */
 335   gss_name_t            gssname;        /* Authentication server name */
 336 #  endif /* HAVE_GSSAPI */
 337 #  ifdef HAVE_AUTHORIZATION_H
 338   AuthorizationRef      auth_ref;       /* Authorization ref */
 339 #  endif /* HAVE_AUTHORIZATION_H */
 340
 341   /**** New in CUPS 1.5 ****/
 342   http_tls_credentials_t tls_credentials;
 343                                         /* TLS credentials */
 344   http_timeout_cb_t     timeout_cb;     /* Timeout callback */
 345   void                  *timeout_data;  /* User data pointer */
 346   double                timeout_value;  /* Timeout in seconds */
 347   int                   wait_value;     /* httpWait value for timeout */
 348 #  ifdef HAVE_GSSAPI
 349   char                  gsshost[256];   /* Hostname for Kerberos */
 350 #  endif /* HAVE_GSSAPI */
 351
 352   /**** New in CUPS 1.7 ****/
 353   int                   tls_upgrade;    /* Non-zero if we are doing an upgrade */
 354   _http_mode_t          mode;           /* _HTTP_MODE_CLIENT or _HTTP_MODE_SERVER */
 355   char                  *accept_encoding,
 356                                         /* Accept-Encoding field */
 357                         *allow,         /* Allow field */
 358                         *server,        /* Server field */
 359                         *default_accept_encoding,
 360                         *default_server,
 361                         *default_user_agent;
 362                                         /* Default field values */
 363 #  ifdef HAVE_LIBZ
 364   _http_coding_t        coding;         /* _HTTP_CODING_xxx */
 365   z_stream              stream;         /* (De)compression stream */
 366   Bytef                 *sbuffer;       /* (De)compression buffer */
 367 #  endif /* HAVE_LIBZ */
 368 };
 369 #  endif /* !_HTTP_NO_PRIVATE */
 370
 371
 372 /*
 373  * Some OS's don't have hstrerror(), most notably Solaris...
 374  */
 375
 376 #  ifndef HAVE_HSTRERROR
 377 extern const char *_cups_hstrerror(int error);
 378 #    define hstrerror _cups_hstrerror
 379 #  endif /* !HAVE_HSTRERROR */
 380
 381
 382 /*
 383  * Some OS's don't have getifaddrs() and freeifaddrs()...
 384  */
 385
 386 #  if !defined(WIN32) && !defined(HAVE_GETIFADDRS)
 387 #    ifdef ifa_dstaddr
 388 #      undef ifa_dstaddr
 389 #    endif /* ifa_dstaddr */
 390 #    ifndef ifr_netmask
 391 #      define ifr_netmask ifr_addr
 392 #    endif /* !ifr_netmask */
 393
 394 struct ifaddrs                          /**** Interface Structure ****/
 395 {
 396   struct ifaddrs        *ifa_next;      /* Next interface in list */
 397   char                  *ifa_name;      /* Name of interface */
 398   unsigned int          ifa_flags;      /* Flags (up, point-to-point, etc.) */
 399   struct sockaddr       *ifa_addr,      /* Network address */
 400                         *ifa_netmask;   /* Address mask */
 401   union
 402   {
 403     struct sockaddr     *ifu_broadaddr; /* Broadcast address of this interface. */
 404     struct sockaddr     *ifu_dstaddr;   /* Point-to-point destination address. */
 405   } ifa_ifu;
 406
 407   void                  *ifa_data;      /* Interface statistics */
 408 };
 409
 410 #    ifndef ifa_broadaddr
 411 #      define ifa_broadaddr ifa_ifu.ifu_broadaddr
 412 #    endif /* !ifa_broadaddr */
 413 #    ifndef ifa_dstaddr
 414 #      define ifa_dstaddr ifa_ifu.ifu_dstaddr
 415 #    endif /* !ifa_dstaddr */
 416
 417 extern int      _cups_getifaddrs(struct ifaddrs **addrs);
 418 #    define getifaddrs _cups_getifaddrs
 419 extern void     _cups_freeifaddrs(struct ifaddrs *addrs);
 420 #    define freeifaddrs _cups_freeifaddrs
 421 #  endif /* !WIN32 && !HAVE_GETIFADDRS */
 422
 423
 424 /*
 425  * Prototypes...
 426  */
 427
 428 extern void             _httpAddrSetPort(http_addr_t *addr, int port);
 429 extern http_tls_credentials_t
 430                         _httpCreateCredentials(cups_array_t *credentials);
 431 extern char             *_httpDecodeURI(char *dst, const char *src,
 432                                         size_t dstsize);
 433 extern void             _httpDisconnect(http_t *http);
 434 extern char             *_httpEncodeURI(char *dst, const char *src,
 435                                         size_t dstsize);
 436 extern void             _httpFreeCredentials(http_tls_credentials_t credentials);
 437 extern const char       *_httpResolveURI(const char *uri, char *resolved_uri,
 438                                          size_t resolved_size, int options,
 439                                          int (*cb)(void *context),
 440                                          void *context);
 441 extern const char       *_httpStatus(cups_lang_t *lang, http_status_t status);
 442 extern void             _httpTLSInitialize(void);
 443 extern size_t           _httpTLSPending(http_t *http);
 444 extern int              _httpTLSRead(http_t *http, char *buf, int len);
 445 extern int              _httpTLSSetCredentials(http_t *http);
 446 extern void             _httpTLSSetOptions(unsigned int options);
 447 extern int              _httpTLSStart(http_t *http);
 448 extern void             _httpTLSStop(http_t *http);
 449 extern int              _httpTLSWrite(http_t *http, const char *buf, int len);
 450 extern int              _httpUpdate(http_t *http, http_status_t *status);
 451 extern int              _httpWait(http_t *http, int msec, int usessl);
 452
 453
 454 /*
 455  * C++ magic...
 456  */
 457
 458 #  ifdef __cplusplus
 459 }
 460 #  endif /* __cplusplus */
 461
 462 #endif /* !_CUPS_HTTP_PRIVATE_H_ */