scheduler/client.h

   1 /*
   2  * "$Id: client.h 11213 2013-08-01 22:23:18Z msweet $"
   3  *
   4  *   Client definitions for the CUPS scheduler.
   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
  16 #ifdef HAVE_AUTHORIZATION_H
  17 #  include <Security/Authorization.h>
  18 #endif /* HAVE_AUTHORIZATION_H */
  19
  20
  21 /*
  22  * HTTP client structure...
  23  */
  24
  25 struct cupsd_client_s
  26 {
  27   http_t                http;           /* HTTP client connection */
  28   ipp_t                 *request,       /* IPP request information */
  29                         *response;      /* IPP response information */
  30   cupsd_location_t      *best;          /* Best match for AAA */
  31   struct timeval        start;          /* Request start time */
  32   http_state_t          operation;      /* Request operation */
  33   off_t                 bytes;          /* Bytes transferred for this request */
  34   int                   type;           /* AuthType for username */
  35   char                  username[HTTP_MAX_VALUE],
  36                                         /* Username from Authorization: line */
  37                         password[HTTP_MAX_VALUE],
  38                                         /* Password from Authorization: line */
  39                         uri[HTTP_MAX_URI],
  40                                         /* Localized URL/URI for GET/PUT */
  41                         *filename,      /* Filename of output file */
  42                         *command,       /* Command to run */
  43                         *options,       /* Options for command */
  44                         *query_string;  /* QUERY_STRING environment variable */
  45   int                   file;           /* Input/output file */
  46   int                   file_ready;     /* Input ready on file/pipe? */
  47   int                   pipe_pid;       /* Pipe process ID (or 0 if not a pipe) */
  48   int                   sent_header,    /* Non-zero if sent HTTP header */
  49                         got_fields,     /* Non-zero if all fields seen */
  50                         header_used;    /* Number of header bytes used */
  51   char                  header[2048];   /* Header from CGI program */
  52   cups_lang_t           *language;      /* Language to use */
  53 #ifdef HAVE_SSL
  54   int                   auto_ssl;       /* Automatic test for SSL/TLS */
  55 #endif /* HAVE_SSL */
  56   http_addr_t           clientaddr;     /* Client address */
  57   char                  clientname[256];/* Client's server name for connection */
  58   int                   clientport;     /* Client's server port for connection */
  59   char                  servername[256];/* Server name for connection */
  60   int                   serverport;     /* Server port for connection */
  61 #ifdef HAVE_GSSAPI
  62   int                   have_gss;       /* Have GSS credentials? */
  63   uid_t                 gss_uid;        /* User ID for local prints */
  64 #endif /* HAVE_GSSAPI */
  65 #ifdef HAVE_AUTHORIZATION_H
  66   AuthorizationRef      authref;        /* Authorization ref */
  67 #endif /* HAVE_AUTHORIZATION_H */
  68 };
  69
  70 #define HTTP(con) &((con)->http)
  71
  72
  73 /*
  74  * HTTP listener structure...
  75  */
  76
  77 typedef struct
  78 {
  79   int                   fd;             /* File descriptor for this server */
  80   http_addr_t           address;        /* Bind address of socket */
  81   http_encryption_t     encryption;     /* To encrypt or not to encrypt... */
  82 } cupsd_listener_t;
  83
  84
  85 /*
  86  * Globals...
  87  */
  88
  89 VAR int                 ListenBackLog   VALUE(SOMAXCONN),
  90                                         /* Max backlog of pending connections */
  91                         LocalPort       VALUE(631),
  92                                         /* Local port to use */
  93                         RemotePort      VALUE(0);
  94                                         /* Remote port to use */
  95 VAR http_encryption_t   LocalEncryption VALUE(HTTP_ENCRYPT_IF_REQUESTED);
  96                                         /* Local port encryption to use */
  97 VAR cups_array_t        *Listeners      VALUE(NULL);
  98                                         /* Listening sockets */
  99 VAR time_t              ListeningPaused VALUE(0);
 100                                         /* Time when listening was paused */
 101 VAR cups_array_t        *Clients        VALUE(NULL),
 102                                         /* HTTP clients */
 103                         *ActiveClients  VALUE(NULL);
 104                                         /* Active HTTP clients */
 105 VAR char                *ServerHeader   VALUE(NULL);
 106                                         /* Server header in requests */
 107 VAR int                 CGIPipes[2]     VALUE2(-1,-1);
 108                                         /* Pipes for CGI error/debug output */
 109 VAR cupsd_statbuf_t     *CGIStatusBuffer VALUE(NULL);
 110                                         /* Status buffer for pipes */
 111
 112
 113 /*
 114  * Prototypes...
 115  */
 116
 117 extern void     cupsdAcceptClient(cupsd_listener_t *lis);
 118 extern void     cupsdCloseAllClients(void);
 119 extern int      cupsdCloseClient(cupsd_client_t *con);
 120 extern void     cupsdDeleteAllListeners(void);
 121 extern int      cupsdFlushHeader(cupsd_client_t *con);
 122 extern void     cupsdPauseListening(void);
 123 extern int      cupsdProcessIPPRequest(cupsd_client_t *con);
 124 extern void     cupsdReadClient(cupsd_client_t *con);
 125 extern void     cupsdResumeListening(void);
 126 extern int      cupsdSendCommand(cupsd_client_t *con, char *command,
 127                                  char *options, int root);
 128 extern int      cupsdSendError(cupsd_client_t *con, http_status_t code,
 129                                int auth_type);
 130 extern int      cupsdSendHeader(cupsd_client_t *con, http_status_t code,
 131                                 char *type, int auth_type);
 132 extern void     cupsdShutdownClient(cupsd_client_t *con);
 133 extern void     cupsdStartListening(void);
 134 extern void     cupsdStopListening(void);
 135 extern void     cupsdUpdateCGI(void);
 136 extern void     cupsdWriteClient(cupsd_client_t *con);
 137
 138 #ifdef HAVE_SSL
 139 extern int      cupsdEndTLS(cupsd_client_t *con);
 140 extern int      cupsdStartTLS(cupsd_client_t *con);
 141 #endif /* HAVE_SSL */
 142
 143
 144 /*
 145  * End of "$Id: client.h 11213 2013-08-01 22:23:18Z msweet $".
 146  */