2 * Configuration file definitions for the CUPS scheduler.
4 * Copyright 2007-2016 by Apple Inc.
5 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
7 * Licensed under Apache License v2.0. See the file "LICENSE" for more information.
17 CUPSD_LOG_PPD
= -5, /* Used internally for PPD keywords */
18 CUPSD_LOG_ATTR
, /* Used internally for attributes */
19 CUPSD_LOG_STATE
, /* Used internally for printer-state-reasons */
20 CUPSD_LOG_JOBSTATE
, /* Used internally for job-state-reasons */
21 CUPSD_LOG_PAGE
, /* Used internally for page logging */
23 CUPSD_LOG_EMERG
, /* Emergency issues */
24 CUPSD_LOG_ALERT
, /* Something bad happened that needs attention */
25 CUPSD_LOG_CRIT
, /* Critical error but server continues */
26 CUPSD_LOG_ERROR
, /* Error condition */
27 CUPSD_LOG_WARN
, /* Warning */
28 CUPSD_LOG_NOTICE
, /* Normal condition that needs logging */
29 CUPSD_LOG_INFO
, /* General information */
30 CUPSD_LOG_DEBUG
, /* General debugging */
31 CUPSD_LOG_DEBUG2
/* Detailed debugging */
36 CUPSD_ACCESSLOG_NONE
, /* Log no requests */
37 CUPSD_ACCESSLOG_CONFIG
, /* Log config requests */
38 CUPSD_ACCESSLOG_ACTIONS
, /* Log config, print, and job management requests */
39 CUPSD_ACCESSLOG_ALL
/* Log everything */
44 CUPSD_TIME_STANDARD
, /* "Standard" Apache/CLF format */
45 CUPSD_TIME_USECS
/* Standard format with microseconds */
50 CUPSD_SANDBOXING_OFF
, /* No sandboxing */
51 CUPSD_SANDBOXING_RELAXED
, /* Relaxed sandboxing */
52 CUPSD_SANDBOXING_STRICT
/* Strict sandboxing */
57 * FatalErrors flags...
60 #define CUPSD_FATAL_NONE 0 /* No errors are fatal */
61 #define CUPSD_FATAL_BROWSE 1 /* Browse bind errors are fatal */
62 #define CUPSD_FATAL_CONFIG 2 /* Config file syntax errors are fatal */
63 #define CUPSD_FATAL_LISTEN 4 /* Listen/Port bind errors are fatal */
64 #define CUPSD_FATAL_LOG 8 /* Log file errors are fatal */
65 #define CUPSD_FATAL_PERMISSIONS 16 /* File permission errors are fatal */
66 #define CUPSD_FATAL_ALL ~0 /* All errors are fatal */
73 #define PRINTCAP_BSD 0 /* Berkeley LPD format */
74 #define PRINTCAP_SOLARIS 1 /* Solaris lpsched format */
75 #define PRINTCAP_PLIST 2 /* macOS plist format */
84 size_t namelen
; /* Length of alias name */
85 char name
[1]; /* Alias name */
93 VAR
char *ConfigurationFile
VALUE(NULL
),
94 /* cupsd.conf file to use */
95 *CupsFilesFile
VALUE(NULL
),
96 /* cups-files.conf file to use */
97 *ServerName
VALUE(NULL
),
99 *ServerAdmin
VALUE(NULL
),
100 /* Administrator's email */
101 *ServerRoot
VALUE(NULL
),
102 /* Root directory for scheduler */
103 *ServerBin
VALUE(NULL
),
104 /* Root directory for binaries */
105 *StateDir
VALUE(NULL
),
106 /* Root directory for state data */
107 *RequestRoot
VALUE(NULL
),
108 /* Directory for request files */
109 *DocumentRoot
VALUE(NULL
);
110 /* Root directory for documents */
111 VAR cups_array_t
*ServerAlias
VALUE(NULL
);
112 /* Alias names for server */
113 VAR
int ServerNameIsIP
VALUE(0);
114 /* Is the ServerName an IP address? */
115 VAR
int NumSystemGroups
VALUE(0);
116 /* Number of system group names */
117 VAR
char *SystemGroups
[MAX_SYSTEM_GROUPS
]
119 /* System group names */
120 VAR gid_t SystemGroupIDs
[MAX_SYSTEM_GROUPS
]
122 /* System group IDs */
123 VAR
char *AccessLog
VALUE(NULL
),
124 /* Access log filename */
125 *ErrorLog
VALUE(NULL
),
126 /* Error log filename */
127 *PageLog
VALUE(NULL
),
128 /* Page log filename */
129 *CacheDir
VALUE(NULL
),
130 /* Cache file directory */
131 *DataDir
VALUE(NULL
),
132 /* Data file directory */
133 *DefaultLanguage
VALUE(NULL
),
134 /* Default language encoding */
135 *DefaultLocale
VALUE(NULL
),
137 *DefaultPaperSize
VALUE(NULL
),
138 /* Default paper size */
139 *ErrorPolicy
VALUE(NULL
),
140 /* Default printer-error-policy */
141 *RIPCache
VALUE(NULL
),
142 /* Amount of memory for RIPs */
143 *TempDir
VALUE(NULL
),
144 /* Temporary directory */
145 *Printcap
VALUE(NULL
),
147 *FontPath
VALUE(NULL
),
148 /* Font search path */
149 *RemoteRoot
VALUE(NULL
),
150 /* Remote root user */
151 *Classification
VALUE(NULL
);
152 /* Classification of system */
153 VAR uid_t User
VALUE(1),
154 /* User ID for server */
156 /* User to run as, used for files */
157 VAR gid_t Group
VALUE(0);
158 /* Group ID for server */
159 VAR cupsd_accesslog_t AccessLogLevel
VALUE(CUPSD_ACCESSLOG_ACTIONS
);
160 /* Access log level */
161 VAR
int ClassifyOverride
VALUE(0),
162 /* Allow overrides? */
163 LogDebugHistory
VALUE(200),
164 /* Amount of automatic debug history */
165 FatalErrors
VALUE(CUPSD_FATAL_CONFIG
),
166 /* Which errors are fatal? */
167 StrictConformance
VALUE(FALSE
),
168 /* Require strict IPP conformance? */
169 SyncOnClose
VALUE(FALSE
);
170 /* Call fsync() when closing files? */
171 VAR mode_t ConfigFilePerm
VALUE(0640U),
172 /* Permissions for config files */
173 LogFilePerm
VALUE(0644U);
174 /* Permissions for log files */
175 VAR cupsd_loglevel_t LogLevel
VALUE(CUPSD_LOG_WARN
);
176 /* Error log level */
177 VAR cupsd_time_t LogTimeFormat
VALUE(CUPSD_TIME_STANDARD
);
178 /* Log file time format */
179 VAR cups_file_t
*LogStderr
VALUE(NULL
);
180 /* Stderr file, if any */
181 VAR cupsd_sandboxing_t Sandboxing
VALUE(CUPSD_SANDBOXING_STRICT
);
182 /* Sandboxing level */
183 VAR
int UseSandboxing
VALUE(1);
184 /* Use sandboxing for child procs? */
185 VAR
int MaxClients
VALUE(100),
186 /* Maximum number of clients */
187 MaxClientsPerHost
VALUE(0),
188 /* Maximum number of clients per host */
189 MaxCopies
VALUE(CUPS_DEFAULT_MAX_COPIES
),
190 /* Maximum number of copies per job */
191 MaxLogSize
VALUE(1024 * 1024),
192 /* Maximum size of log files */
193 MaxRequestSize
VALUE(0),
194 /* Maximum size of IPP requests */
195 HostNameLookups
VALUE(FALSE
),
196 /* Do we do reverse lookups? */
197 Timeout
VALUE(DEFAULT_TIMEOUT
),
198 /* Timeout during requests */
199 KeepAlive
VALUE(TRUE
),
200 /* Support the Keep-Alive option? */
201 KeepAliveTimeout
VALUE(DEFAULT_KEEPALIVE
),
202 /* Timeout between requests */
203 FileDevice
VALUE(FALSE
),
204 /* Allow file: devices? */
205 FilterLimit
VALUE(0),
206 /* Max filter cost at any time */
207 FilterLevel
VALUE(0),
208 /* Current filter level */
210 /* Nice value for filters */
211 ReloadTimeout
VALUE(DEFAULT_KEEPALIVE
),
212 /* Timeout before reload from SIGHUP */
213 RootCertDuration
VALUE(300),
214 /* Root certificate update interval */
215 PrintcapFormat
VALUE(PRINTCAP_BSD
),
216 /* Format of printcap file? */
217 DefaultShared
VALUE(TRUE
),
218 /* Share printers by default? */
219 MultipleOperationTimeout
VALUE(DEFAULT_TIMEOUT
),
220 /* multiple-operation-time-out value */
221 WebInterface
VALUE(CUPS_DEFAULT_WEBIF
);
222 /* Enable the web interface? */
223 VAR cups_file_t
*AccessFile
VALUE(NULL
),
224 /* Access log file */
225 *ErrorFile
VALUE(NULL
),
227 *PageFile
VALUE(NULL
);
229 VAR
char *PageLogFormat
VALUE(NULL
);
230 /* Page log format */
231 VAR mime_t
*MimeDatabase
VALUE(NULL
);
232 /* MIME type database */
233 VAR
int NumMimeTypes
VALUE(0);
234 /* Number of MIME types */
235 VAR
const char **MimeTypes
VALUE(NULL
);
236 /* Array of MIME types */
239 VAR
int CreateSelfSignedCerts
VALUE(TRUE
);
240 /* Automatically create self-signed certs? */
241 VAR
char *ServerKeychain
VALUE(NULL
);
242 /* Keychain holding cert + key */
243 #endif /* HAVE_SSL */
246 VAR
int IdleExitTimeout
VALUE(60);
247 /* Time after which an idle cupsd will exit */
248 #endif /* HAVE_ONDEMAND */
250 #ifdef HAVE_AUTHORIZATION_H
251 VAR
char *SystemGroupAuthKey
VALUE(NULL
);
252 /* System group auth key */
253 #endif /* HAVE_AUTHORIZATION_H */
256 VAR
char *GSSServiceName
VALUE(NULL
);
257 /* GSS service name */
258 VAR
int HaveServerCreds
VALUE(0);
259 /* Do we have server credentials? */
260 VAR gss_cred_id_t ServerCreds
; /* Server's GSS credentials */
261 #endif /* HAVE_GSSAPI */
268 extern void cupsdAddAlias(cups_array_t
*aliases
, const char *name
);
269 extern int cupsdCheckLogFile(cups_file_t
**lf
, const char *logname
);
270 extern int cupsdCheckPermissions(const char *filename
,
271 const char *suffix
, mode_t mode
,
272 uid_t user
, gid_t group
, int is_dir
,
274 extern int cupsdCheckProgram(const char *filename
, cupsd_printer_t
*p
);
275 extern int cupsdDefaultAuthType(void);
276 extern void cupsdFreeAliases(cups_array_t
*aliases
);
277 extern char *cupsdGetDateTime(struct timeval
*t
, cupsd_time_t format
);
278 extern int cupsdLogClient(cupsd_client_t
*con
, int level
,
279 const char *message
, ...)
280 __attribute__((__format__(__printf__
, 3, 4)));
281 extern void cupsdLogFCMessage(void *context
, _cups_fc_result_t result
,
282 const char *message
);
284 extern int cupsdLogGSSMessage(int level
, OM_uint32 major_status
,
285 OM_uint32 minor_status
,
286 const char *message
, ...);
287 #endif /* HAVE_GSSAPI */
288 extern int cupsdLogJob(cupsd_job_t
*job
, int level
, const char *message
,
289 ...) __attribute__((__format__(__printf__
, 3, 4)));
290 extern int cupsdLogMessage(int level
, const char *message
, ...)
291 __attribute__ ((__format__ (__printf__
, 2, 3)));
292 extern int cupsdLogPage(cupsd_job_t
*job
, const char *page
);
293 extern int cupsdLogRequest(cupsd_client_t
*con
, http_status_t code
);
294 extern int cupsdReadConfiguration(void);
295 extern int cupsdWriteErrorLog(int level
, const char *message
);