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