1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2016 Andy Wingo <wingo@pobox.com>
3 ;;; Copyright © 2017 Clément Lassieur <clement@lassieur.org>
4 ;;; Copyright © 2018 Ricardo Wurmus <rekado@elephly.net>
5 ;;; Copyright © 2019 Alex Griffin <a@ajgrf.com>
6 ;;; Copyright © 2019 Tobias Geerinckx-Rice <me@tobias.gr>
8 ;;; This file is part of GNU Guix.
10 ;;; GNU Guix is free software; you can redistribute it and/or modify it
11 ;;; under the terms of the GNU General Public License as published by
12 ;;; the Free Software Foundation; either version 3 of the License, or (at
13 ;;; your option) any later version.
15 ;;; GNU Guix is distributed in the hope that it will be useful, but
16 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;;; GNU General Public License for more details.
20 ;;; You should have received a copy of the GNU General Public License
21 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
23 (define-module (gnu services cups)
24 #:use-module (gnu services)
25 #:use-module (gnu services shepherd)
26 #:use-module (gnu services configuration)
27 #:use-module (gnu system shadow)
28 #:use-module (gnu packages admin)
29 #:use-module (gnu packages cups)
30 #:use-module (gnu packages tls)
31 #:use-module (guix packages)
32 #:use-module (guix records)
33 #:use-module (guix gexp)
34 #:use-module (ice-9 match)
35 #:use-module ((srfi srfi-1) #:select (append-map))
36 #:export (cups-service-type
38 opaque-cups-configuration
42 location-access-control
43 operation-access-control
44 method-access-control))
48 ;;; Service defininition for the CUPS printing system.
52 (define %cups-accounts
53 (list (user-group (name "lp") (system? #t))
54 (user-group (name "lpadmin") (system? #t))
59 (comment "System user for invoking printing helper programs")
60 (home-directory "/var/empty")
61 (shell (file-append shadow "/sbin/nologin")))))
63 (define (uglify-field-name field-name)
64 (let ((str (symbol->string field-name)))
67 (string-split (if (string-suffix? "?" str)
68 (substring str 0 (1- (string-length str)))
72 (define (serialize-field field-name val)
73 (format #t "~a ~a\n" (uglify-field-name field-name) val))
75 (define (serialize-string field-name val)
76 (serialize-field field-name val))
78 (define (multiline-string-list? val)
81 (and (string? x) (not (string-index x #\space))))
83 (define (serialize-multiline-string-list field-name val)
84 (for-each (lambda (str) (serialize-field field-name str)) val))
86 (define (comma-separated-string-list? val)
89 (and (string? x) (not (string-index x #\,))))
91 (define (serialize-comma-separated-string-list field-name val)
92 (serialize-field field-name (string-join val ",")))
94 (define (space-separated-string-list? val)
97 (and (string? x) (not (string-index x #\space))))
99 (define (serialize-space-separated-string-list field-name val)
100 (serialize-field field-name (string-join val " ")))
102 (define (space-separated-symbol-list? val)
103 (and (list? val) (and-map symbol? val)))
104 (define (serialize-space-separated-symbol-list field-name val)
105 (serialize-field field-name (string-join (map symbol->string val) " ")))
107 (define (file-name? val)
109 (string-prefix? "/" val)))
110 (define (serialize-file-name field-name val)
111 (serialize-string field-name val))
113 (define (serialize-boolean field-name val)
114 (serialize-string field-name (if val "yes" "no")))
116 (define (non-negative-integer? val)
117 (and (exact-integer? val) (not (negative? val))))
118 (define (serialize-non-negative-integer field-name val)
119 (serialize-field field-name val))
121 (define-syntax define-enumerated-field-type
123 (define (id-append ctx . parts)
124 (datum->syntax ctx (apply symbol-append (map syntax->datum parts))))
126 ((_ name (option ...))
128 (define (#,(id-append #'name #'name #'?) x)
129 (memq x '(option ...)))
130 (define (#,(id-append #'name #'serialize- #'name) field-name val)
131 (serialize-field field-name val)))))))
133 (define-enumerated-field-type access-log-level
134 (config actions all))
135 (define-enumerated-field-type browse-local-protocols
137 (define-enumerated-field-type default-auth-type
139 (define-enumerated-field-type default-encryption
140 (Never IfRequested Required))
141 (define-enumerated-field-type error-policy
142 (abort-job retry-job retry-current-job stop-printer))
143 (define-enumerated-field-type log-level
144 (none emerg alert crit error warn notice info debug debug2))
145 (define-enumerated-field-type log-time-format
147 (define-enumerated-field-type server-tokens
148 (None ProductOnly Major Minor Minimal OS Full))
149 (define-enumerated-field-type method
150 (DELETE GET HEAD OPTIONS POST PUT TRACE))
151 (define-enumerated-field-type sandboxing
154 (define (method-list? val)
155 (and (list? val) (and-map method? val)))
156 (define (serialize-method-list field-name val)
157 (serialize-field field-name (string-join (map symbol->string val) " ")))
159 (define (host-name-lookups? val)
160 (memq val '(#f #t 'double)))
161 (define (serialize-host-name-lookups field-name val)
162 (serialize-field field-name
163 (match val (#f "No") (#t "Yes") ('double "Double"))))
165 (define (host-name-list-or-*? x)
167 (and (list? x) (and-map string? x))))
168 (define (serialize-host-name-list-or-* field-name val)
169 (serialize-field field-name (match val
171 (names (string-join names " ")))))
173 (define (boolean-or-non-negative-integer? x)
174 (or (boolean? x) (non-negative-integer? x)))
175 (define (serialize-boolean-or-non-negative-integer field-name x)
177 (serialize-boolean field-name x)
178 (serialize-non-negative-integer field-name x)))
180 (define (ssl-options? x)
182 (and-map (lambda (elt) (memq elt '(AllowRC4
186 (define (serialize-ssl-options field-name val)
187 (serialize-field field-name
190 (opts (string-join (map symbol->string opts) " ")))))
192 (define (serialize-access-control x)
195 (define (serialize-access-control-list field-name val)
196 (for-each serialize-access-control val))
197 (define (access-control-list? val)
198 (and (list? val) (and-map string? val)))
200 (define-configuration operation-access-control
202 (space-separated-symbol-list '())
203 "IPP operations to which this access control applies.")
205 (access-control-list '())
206 "Access control directives, as a list of strings. Each string should be one directive, such as \"Order allow,deny\"."))
208 (define-configuration method-access-control
211 "If @code{#t}, apply access controls to all methods except the listed
212 methods. Otherwise apply to only the listed methods.")
215 "Methods to which this access control applies.")
217 (access-control-list '())
218 "Access control directives, as a list of strings. Each string should be one directive, such as \"Order allow,deny\"."))
220 (define (serialize-operation-access-control x)
221 (format #t "<Limit ~a>\n"
222 (string-join (map symbol->string
223 (operation-access-control-operations x)) " "))
224 (serialize-configuration
226 (filter (lambda (field)
227 (not (eq? (configuration-field-name field) 'operations)))
228 operation-access-control-fields))
229 (format #t "</Limit>\n"))
231 (define (serialize-method-access-control x)
232 (let ((limit (if (method-access-control-reverse? x) "LimitExcept" "Limit")))
233 (format #t "<~a ~a>\n" limit
234 (string-join (map symbol->string
235 (method-access-control-methods x)) " "))
236 (serialize-configuration
238 (filter (lambda (field)
239 (case (configuration-field-name field)
240 ((reverse? methods) #f)
242 method-access-control-fields))
243 (format #t "</~a>\n" limit)))
245 (define (operation-access-control-list? val)
246 (and (list? val) (and-map operation-access-control? val)))
247 (define (serialize-operation-access-control-list field-name val)
248 (for-each serialize-operation-access-control val))
250 (define (method-access-control-list? val)
251 (and (list? val) (and-map method-access-control? val)))
252 (define (serialize-method-access-control-list field-name val)
253 (for-each serialize-method-access-control val))
255 (define-configuration location-access-control
257 (file-name (configuration-missing-field 'location-access-control 'path))
258 "Specifies the URI path to which the access control applies.")
260 (access-control-list '())
261 "Access controls for all access to this path, in the same format as the
262 @code{access-controls} of @code{operation-access-control}.")
263 (method-access-controls
264 (method-access-control-list '())
265 "Access controls for method-specific access to this path."))
267 (define (serialize-location-access-control x)
268 (format #t "<Location ~a>\n" (location-access-control-path x))
269 (serialize-configuration
271 (filter (lambda (field)
272 (not (eq? (configuration-field-name field) 'path)))
273 location-access-control-fields))
274 (format #t "</Location>\n"))
276 (define (location-access-control-list? val)
277 (and (list? val) (and-map location-access-control? val)))
278 (define (serialize-location-access-control-list field-name val)
279 (for-each serialize-location-access-control val))
281 (define-configuration policy-configuration
283 (string (configuration-missing-field 'policy-configuration 'name))
284 "Name of the policy.")
286 (string "@OWNER @SYSTEM")
287 "Specifies an access list for a job's private values. @code{@@ACL} maps to
288 the printer's requesting-user-name-allowed or requesting-user-name-denied
289 values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to the
290 groups listed for the @code{system-group} field of the @code{files-config}
291 configuration, which is reified into the @code{cups-files.conf(5)} file.
292 Other possible elements of the access list include specific user names, and
293 @code{@@@var{group}} to indicate members of a specific group. The access list
294 may also be simply @code{all} or @code{default}.")
296 (string (string-join '("job-name" "job-originating-host-name"
297 "job-originating-user-name" "phone")))
298 "Specifies the list of job values to make private, or @code{all},
299 @code{default}, or @code{none}.")
301 (subscription-private-access
302 (string "@OWNER @SYSTEM")
303 "Specifies an access list for a subscription's private values.
304 @code{@@ACL} maps to the printer's requesting-user-name-allowed or
305 requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner.
306 @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of
307 the @code{files-config} configuration, which is reified into the
308 @code{cups-files.conf(5)} file. Other possible elements of the access list
309 include specific user names, and @code{@@@var{group}} to indicate members of a
310 specific group. The access list may also be simply @code{all} or
312 (subscription-private-values
313 (string (string-join '("notify-events" "notify-pull-method"
314 "notify-recipient-uri" "notify-subscriber-user-name"
317 "Specifies the list of job values to make private, or @code{all},
318 @code{default}, or @code{none}.")
321 (operation-access-control-list '())
322 "Access control by IPP operation."))
324 (define (serialize-policy-configuration x)
325 (format #t "<Policy ~a>\n" (policy-configuration-name x))
326 (serialize-configuration
328 (filter (lambda (field)
329 (not (eq? (configuration-field-name field) 'name)))
330 policy-configuration-fields))
331 (format #t "</Policy>\n"))
333 (define (policy-configuration-list? x)
334 (and (list? x) (and-map policy-configuration? x)))
335 (define (serialize-policy-configuration-list field-name x)
336 (for-each serialize-policy-configuration x))
338 (define (log-location? x)
342 (define (serialize-log-location field-name x)
344 (serialize-file-name field-name x)
345 (serialize-field field-name x)))
347 (define-configuration files-configuration
349 (log-location "/var/log/cups/access_log")
350 "Defines the access log filename. Specifying a blank filename disables
351 access log generation. The value @code{stderr} causes log entries to be sent
352 to the standard error file when the scheduler is running in the foreground, or
353 to the system log daemon when run in the background. The value @code{syslog}
354 causes log entries to be sent to the system log daemon. The server name may
355 be included in filenames using the string @code{%s}, as in
356 @code{/var/log/cups/%s-access_log}.")
358 (file-name "/var/cache/cups")
359 "Where CUPS should cache data.")
362 "Specifies the permissions for all configuration files that the scheduler
365 Note that the permissions for the printers.conf file are currently masked to
366 only allow access from the scheduler user (typically root). This is done
367 because printer device URIs sometimes contain sensitive authentication
368 information that should not be generally known on the system. There is no way
369 to disable this security feature.")
370 ;; Not specifying data-dir and server-bin options as we handle these
371 ;; manually. For document-root, the CUPS package has that path
374 (log-location "/var/log/cups/error_log")
375 "Defines the error log filename. Specifying a blank filename disables
376 access log generation. The value @code{stderr} causes log entries to be sent
377 to the standard error file when the scheduler is running in the foreground, or
378 to the system log daemon when run in the background. The value @code{syslog}
379 causes log entries to be sent to the system log daemon. The server name may
380 be included in filenames using the string @code{%s}, as in
381 @code{/var/log/cups/%s-error_log}.")
383 (string "all -browse")
384 "Specifies which errors are fatal, causing the scheduler to exit. The kind
390 All of the errors below are fatal.
392 Browsing initialization errors are fatal, for example failed connections to
395 Configuration file syntax errors are fatal.
397 Listen or Port errors are fatal, except for IPv6 failures on the loopback or
398 @code{any} addresses.
400 Log file creation or write errors are fatal.
402 Bad startup file permissions are fatal, for example shared TLS certificate and
403 key files with world-read permissions.
407 "Specifies whether the file pseudo-device can be used for new printer
408 queues. The URI @url{file:///dev/null} is always allowed.")
411 "Specifies the group name or ID that will be used when executing external
415 "Specifies the permissions for all log files that the scheduler writes.")
417 (log-location "/var/log/cups/page_log")
418 "Defines the page log filename. Specifying a blank filename disables
419 access log generation. The value @code{stderr} causes log entries to be sent
420 to the standard error file when the scheduler is running in the foreground, or
421 to the system log daemon when run in the background. The value @code{syslog}
422 causes log entries to be sent to the system log daemon. The server name may
423 be included in filenames using the string @code{%s}, as in
424 @code{/var/log/cups/%s-page_log}.")
427 "Specifies the username that is associated with unauthenticated accesses by
428 clients claiming to be the root user. The default is @code{remroot}.")
430 (file-name "/var/spool/cups")
431 "Specifies the directory that contains print jobs and other HTTP request
435 "Specifies the level of security sandboxing that is applied to print
436 filters, backends, and other child processes of the scheduler; either
437 @code{relaxed} or @code{strict}. This directive is currently only
438 used/supported on macOS.")
440 (file-name "/etc/cups/ssl")
441 "Specifies the location of TLS certificates and private keys. CUPS will
442 look for public and private keys in this directory: a @code{.crt} files for
443 PEM-encoded certificates and corresponding @code{.key} files for PEM-encoded
446 (file-name "/etc/cups")
447 "Specifies the directory containing the server configuration files.")
450 "Specifies whether the scheduler calls fsync(2) after writing configuration
453 (space-separated-string-list '("lpadmin" "wheel" "root"))
454 "Specifies the group(s) to use for @code{@@SYSTEM} group authentication.")
456 (file-name "/var/spool/cups/tmp")
457 "Specifies the directory where temporary files are stored.")
460 "Specifies the user name or ID that is used when running external
463 (string "variable value")
464 "Set the specified environment variable to be passed to child processes."))
466 (define (serialize-files-configuration field-name val)
469 (define (environment-variables? vars)
470 (space-separated-string-list? vars))
471 (define (serialize-environment-variables field-name vars)
473 (serialize-space-separated-string-list field-name vars)))
475 (define (package-list? val)
476 (and (list? val) (and-map package? val)))
477 (define (serialize-package-list field-name val)
480 (define-configuration cups-configuration
485 (package-list (list cups-filters))
486 "Drivers and other extensions to the CUPS package.")
488 (files-configuration (files-configuration))
489 "Configuration of where to write logs, what directories to use for print
490 spools, and related privileged configuration parameters.")
492 (access-log-level 'actions)
493 "Specifies the logging level for the AccessLog file. The @code{config}
494 level logs when printers and classes are added, deleted, or modified and when
495 configuration files are accessed or updated. The @code{actions} level logs
496 when print jobs are submitted, held, released, modified, or canceled, and any
497 of the conditions for @code{config}. The @code{all} level logs all
501 "Specifies whether to purge job history data automatically when it is no
502 longer required for quotas.")
503 (browse-dns-sd-sub-types
504 (comma-separated-string-list (list "_cups"))
505 "Specifies a list of DNS-SD sub-types to advertise for each shared printer.
506 For example, @samp{\"_cups\" \"_print\"} will tell network clients that both
507 CUPS sharing and IPP Everywhere are supported.")
508 (browse-local-protocols
509 (browse-local-protocols 'dnssd)
510 "Specifies which protocols to use for local printer sharing.")
513 "Specifies whether the CUPS web interface is advertised.")
516 "Specifies whether shared printers are advertised.")
519 "Specifies the security classification of the server.
520 Any valid banner name can be used, including \"classified\", \"confidential\",
521 \"secret\", \"topsecret\", and \"unclassified\", or the banner can be omitted
522 to disable secure printing functions.")
525 "Specifies whether users may override the classification (cover page) of
526 individual print jobs using the @code{job-sheets} option.")
528 (default-auth-type 'Basic)
529 "Specifies the default type of authentication to use.")
531 (default-encryption 'Required)
532 "Specifies whether encryption will be used for authenticated requests.")
535 "Specifies the default language to use for text and web content.")
538 "Specifies the default paper size for new print queues. @samp{\"Auto\"}
539 uses a locale-specific default, while @samp{\"None\"} specifies there is no
540 default paper size. Specific size names are typically @samp{\"Letter\"} or
544 "Specifies the default access policy to use.")
547 "Specifies whether local printers are shared by default.")
548 (dirty-clean-interval
549 (non-negative-integer 30)
550 "Specifies the delay for updating of configuration and state files, in
551 seconds. A value of 0 causes the update to happen as soon as possible,
552 typically within a few milliseconds.")
554 (error-policy 'stop-printer)
555 "Specifies what to do when an error occurs. Possible values are
556 @code{abort-job}, which will discard the failed print job; @code{retry-job},
557 which will retry the job at a later time; @code{retry-current-job}, which retries
558 the failed job immediately; and @code{stop-printer}, which stops the
561 (non-negative-integer 0)
562 "Specifies the maximum cost of filters that are run concurrently, which can
563 be used to minimize disk, memory, and CPU resource problems. A limit of 0
564 disables filter limiting. An average print to a non-PostScript printer needs
565 a filter limit of about 200. A PostScript printer needs about half
566 that (100). Setting the limit below these thresholds will effectively limit
567 the scheduler to printing a single job at any time.")
569 (non-negative-integer 0)
570 "Specifies the scheduling priority of filters that are run to print a job.
571 The nice value ranges from 0, the highest priority, to 19, the lowest
573 ;; Add this option if the package is built with Kerberos support.
576 ;; "Specifies the service name when using Kerberos authentication.")
578 (host-name-lookups #f)
579 "Specifies whether to do reverse lookups on connecting clients.
580 The @code{double} setting causes @code{cupsd} to verify that the hostname
581 resolved from the address matches one of the addresses returned for that
582 hostname. Double lookups also prevent clients with unregistered addresses
583 from connecting to your server. Only set this option to @code{#t} or
584 @code{double} if absolutely required.")
585 ;; Add this option if the package is built with launchd/systemd support.
586 ;; (idle-exit-timeout
587 ;; (non-negative-integer 60)
588 ;; "Specifies the length of time to wait before shutting down due to
589 ;; inactivity. Note: Only applicable when @code{cupsd} is run on-demand
590 ;; (e.g., with @code{-l}).")
592 (non-negative-integer 30)
593 "Specifies the number of seconds to wait before killing the filters and
594 backend associated with a canceled or held job.")
596 (non-negative-integer 30)
597 "Specifies the interval between retries of jobs in seconds. This is
598 typically used for fax queues but can also be used with normal print queues
599 whose error policy is @code{retry-job} or @code{retry-current-job}.")
601 (non-negative-integer 5)
602 "Specifies the number of retries that are done for jobs. This is typically
603 used for fax queues but can also be used with normal print queues whose error
604 policy is @code{retry-job} or @code{retry-current-job}.")
607 "Specifies whether to support HTTP keep-alive connections.")
609 (non-negative-integer 30)
610 "Specifies how long an idle client connection remains open, in seconds.")
612 (non-negative-integer 0)
613 "Specifies the maximum size of print files, IPP requests, and HTML form
614 data. A limit of 0 disables the limit check.")
616 (multiline-string-list '("localhost:631" "/var/run/cups/cups.sock"))
617 "Listens on the specified interfaces for connections. Valid values are of
618 the form @var{address}:@var{port}, where @var{address} is either an IPv6
619 address enclosed in brackets, an IPv4 address, or @code{*} to indicate all
620 addresses. Values can also be file names of local UNIX domain sockets. The
621 Listen directive is similar to the Port directive but allows you to restrict
622 access to specific interfaces or networks.")
624 (non-negative-integer 128)
625 "Specifies the number of pending connections that will be allowed. This
626 normally only affects very busy servers that have reached the MaxClients
627 limit, but can also be triggered by large numbers of simultaneous connections.
628 When the limit is reached, the operating system will refuse additional
629 connections until the scheduler can accept the pending ones.")
630 (location-access-controls
631 (location-access-control-list
632 (list (location-access-control
634 (access-controls '("Order allow,deny"
636 (location-access-control
638 (access-controls '("Order allow,deny"
640 (location-access-control
642 (access-controls '("Order allow,deny"
644 "Require user @SYSTEM"
645 "Allow localhost")))))
646 "Specifies a set of additional access controls.")
648 (non-negative-integer 100)
649 "Specifies the number of debugging messages that are retained for logging
650 if an error occurs in a print job. Debug messages are logged regardless of
651 the LogLevel setting.")
654 "Specifies the level of logging for the ErrorLog file. The value
655 @code{none} stops all logging while @code{debug2} logs everything.")
657 (log-time-format 'standard)
658 "Specifies the format of the date and time in the log files. The value
659 @code{standard} logs whole seconds while @code{usecs} logs microseconds.")
661 (non-negative-integer 100)
662 "Specifies the maximum number of simultaneous clients that are allowed by
664 (max-clients-per-host
665 (non-negative-integer 100)
666 "Specifies the maximum number of simultaneous clients that are allowed from
669 (non-negative-integer 9999)
670 "Specifies the maximum number of copies that a user can print of each
673 (non-negative-integer 0)
674 "Specifies the maximum time a job may remain in the @code{indefinite} hold
675 state before it is canceled. A value of 0 disables cancellation of held
678 (non-negative-integer 500)
679 "Specifies the maximum number of simultaneous jobs that are allowed. Set
680 to 0 to allow an unlimited number of jobs.")
681 (max-jobs-per-printer
682 (non-negative-integer 0)
683 "Specifies the maximum number of simultaneous jobs that are allowed per
684 printer. A value of 0 allows up to MaxJobs jobs per printer.")
686 (non-negative-integer 0)
687 "Specifies the maximum number of simultaneous jobs that are allowed per
688 user. A value of 0 allows up to MaxJobs jobs per user.")
690 (non-negative-integer 10800)
691 "Specifies the maximum time a job may take to print before it is canceled,
692 in seconds. Set to 0 to disable cancellation of \"stuck\" jobs.")
694 (non-negative-integer 1048576)
695 "Specifies the maximum size of the log files before they are rotated, in
696 bytes. The value 0 disables log rotation.")
697 (multiple-operation-timeout
698 (non-negative-integer 300)
699 "Specifies the maximum amount of time to allow between files in a multiple
700 file print job, in seconds.")
703 "Specifies the format of PageLog lines. Sequences beginning with
704 percent (@samp{%}) characters are replaced with the corresponding information,
705 while all other characters are copied literally. The following percent
706 sequences are recognized:
710 insert a single percent character
712 insert the value of the specified IPP attribute
714 insert the number of copies for the current page
716 insert the current page number
718 insert the current date and time in common log format
722 insert the printer name
727 A value of the empty string disables page logging. The string @code{%p %u %j
728 %T %P %C %@{job-billing@} %@{job-originating-host-name@} %@{job-name@}
729 %@{media@} %@{sides@}} creates a page log with the standard items.")
730 (environment-variables
731 (environment-variables '())
732 "Passes the specified environment variable(s) to child processes; a list of
735 (policy-configuration-list
736 (list (policy-configuration
740 (operation-access-control
743 Send-URI Hold-Job Release-Job Restart-Job Purge-Jobs
744 Cancel-Job Close-Job Cancel-My-Jobs Set-Job-Attributes
745 Create-Job-Subscription Renew-Subscription
746 Cancel-Subscription Get-Notifications
747 Reprocess-Job Cancel-Current-Job Suspend-Current-Job
748 Resume-Job CUPS-Move-Job Validate-Job
750 (access-controls '("Require user @OWNER @SYSTEM"
751 "Order deny,allow")))
752 (operation-access-control
756 Resume-Printer Set-Printer-Attributes Enable-Printer
757 Disable-Printer Pause-Printer-After-Current-Job
758 Hold-New-Jobs Release-Held-New-Jobs Deactivate-Printer
759 Activate-Printer Restart-Printer Shutdown-Printer
760 Startup-Printer Promote-Job Schedule-Job-After
761 CUPS-Authenticate-Job CUPS-Add-Printer
762 CUPS-Delete-Printer CUPS-Add-Class CUPS-Delete-Class
763 CUPS-Accept-Jobs CUPS-Reject-Jobs CUPS-Set-Default))
764 (access-controls '("AuthType Basic"
765 "Require user @SYSTEM"
766 "Order deny,allow")))
767 (operation-access-control
769 (access-controls '("Order deny,allow"))))))))
770 "Specifies named access control policies.")
773 (non-negative-integer 631)
774 "Listens to the specified port number for connections.")
776 (boolean-or-non-negative-integer 86400)
777 "Specifies whether job files (documents) are preserved after a job is
778 printed. If a numeric value is specified, job files are preserved for the
779 indicated number of seconds after printing. Otherwise a boolean value applies
781 (preserve-job-history
782 (boolean-or-non-negative-integer #t)
783 "Specifies whether the job history is preserved after a job is printed.
784 If a numeric value is specified, the job history is preserved for the
785 indicated number of seconds after printing. If @code{#t}, the job history is
786 preserved until the MaxJobs limit is reached.")
788 (non-negative-integer 30)
789 "Specifies the amount of time to wait for job completion before restarting
793 "Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.")
795 (string "root@localhost.localdomain")
796 "Specifies the email address of the server administrator.")
798 (host-name-list-or-* '*)
799 "The ServerAlias directive is used for HTTP Host header validation when
800 clients connect to the scheduler from external interfaces. Using the special
801 name @code{*} can expose your system to known browser-based DNS rebinding
802 attacks, even when accessing sites through a firewall. If the auto-discovery
803 of alternate names does not work, we recommend listing each alternate name
804 with a ServerAlias directive instead of using @code{*}.")
807 "Specifies the fully-qualified host name of the server.")
809 (server-tokens 'Minimal)
810 "Specifies what information is included in the Server header of HTTP
811 responses. @code{None} disables the Server header. @code{ProductOnly}
812 reports @code{CUPS}. @code{Major} reports @code{CUPS 2}. @code{Minor}
813 reports @code{CUPS 2.0}. @code{Minimal} reports @code{CUPS 2.0.0}. @code{OS}
814 reports @code{CUPS 2.0.0 (@var{uname})} where @var{uname} is the output of the
815 @code{uname} command. @code{Full} reports @code{CUPS 2.0.0 (@var{uname})
818 (multiline-string-list '())
819 "Listens on the specified interfaces for encrypted connections. Valid
820 values are of the form @var{address}:@var{port}, where @var{address} is either
821 an IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate
825 "Sets encryption options. By default, CUPS only supports encryption
826 using TLS v1.0 or higher using known secure cipher suites. Security is
827 reduced when @code{Allow} options are used, and enhanced when @code{Deny}
828 options are used. The @code{AllowRC4} option enables the 128-bit RC4 cipher
829 suites, which are required for some older clients. The @code{AllowSSL3} option
830 enables SSL v3.0, which is required for some older clients that do not support
831 TLS v1.0. The @code{DenyCBC} option disables all CBC cipher suites. The
832 @code{DenyTLS1.0} option disables TLS v1.0 support - this sets the minimum
833 protocol version to TLS v1.1.")
836 (non-negative-integer 631)
837 "Listens on the specified port for encrypted connections.")
840 "Specifies whether the scheduler requires clients to strictly adhere to the
841 IPP specifications.")
843 (non-negative-integer 300)
844 "Specifies the HTTP request timeout, in seconds.")
847 "Specifies whether the web interface is enabled."))
849 (define-configuration opaque-cups-configuration
855 "Drivers and other extensions to the CUPS package.")
857 (string (configuration-missing-field 'opaque-cups-configuration
859 "The contents of the @code{cupsd.conf} to use.")
861 (string (configuration-missing-field 'opaque-cups-configuration
863 "The contents of the @code{cups-files.conf} to use."))
865 (define %cups-activation
867 (with-imported-modules '((guix build utils))
869 (use-modules (guix build utils))
870 (define (mkdir-p/perms directory owner perms)
872 (chown directory (passwd:uid owner) (passwd:gid owner))
873 (chmod directory perms))
874 (define (build-subject parameters)
877 (let ((k (car pair)) (v (cdr pair)))
878 (define (escape-char str chr)
879 (string-join (string-split str chr) (string #\\ chr)))
880 (string-append "/" k "="
881 (escape-char (escape-char v #\=) #\/))))
882 (filter (lambda (pair) (cdr pair)) parameters))))
883 (define* (create-self-signed-certificate-if-absent
884 #:key private-key public-key (owner (getpwnam "root"))
885 (common-name (gethostname))
886 (organization-name "Guix")
887 (organization-unit-name "Default Self-Signed Certificate")
888 (subject-parameters `(("CN" . ,common-name)
889 ("O" . ,organization-name)
890 ("OU" . ,organization-unit-name)))
891 (subject (build-subject subject-parameters)))
892 ;; Note that by default, OpenSSL outputs keys in PEM format. This
894 (unless (file-exists? private-key)
896 ((zero? (system* (string-append #$openssl "/bin/openssl")
897 "genrsa" "-out" private-key "2048"))
898 (chown private-key (passwd:uid owner) (passwd:gid owner))
899 (chmod private-key #o400))
901 (format (current-error-port)
902 "Failed to create private key at ~a.\n" private-key))))
903 (unless (file-exists? public-key)
905 ((zero? (system* (string-append #$openssl "/bin/openssl")
906 "req" "-new" "-x509" "-key" private-key
907 "-out" public-key "-days" "3650"
908 "-batch" "-subj" subject))
909 (chown public-key (passwd:uid owner) (passwd:gid owner))
910 (chmod public-key #o444))
912 (format (current-error-port)
913 "Failed to create public key at ~a.\n" public-key)))))
914 (let ((user (getpwnam "lp")))
915 (mkdir-p/perms "/var/run/cups" user #o755)
916 (mkdir-p/perms "/var/spool/cups" user #o755)
917 (mkdir-p/perms "/var/spool/cups/tmp" user #o755)
918 (mkdir-p/perms "/var/log/cups" user #o755)
919 (mkdir-p/perms "/var/cache/cups" user #o770)
920 (mkdir-p/perms "/etc/cups" user #o755)
921 (mkdir-p/perms "/etc/cups/ssl" user #o700)
922 ;; This certificate is used for HTTPS connections to the CUPS web
924 (create-self-signed-certificate-if-absent
925 #:private-key "/etc/cups/ssl/localhost.key"
926 #:public-key "/etc/cups/ssl/localhost.crt"
927 #:owner (getpwnam "root")
928 #:common-name (format #f "CUPS service on ~a" (gethostname)))))))
930 (define (union-directory name packages paths)
933 (with-imported-modules '((guix build utils))
935 (use-modules (guix build utils)
944 (let* ((tail (substring src (string-length package)))
945 (dst (string-append #$output tail)))
946 (mkdir-p (dirname dst))
947 ;; CUPS currently symlinks in some data from cups-filters
948 ;; to its output dir. Probably we should stop doing this
949 ;; and instead rely only on the CUPS service to union the
950 ;; relevant set of CUPS packages.
951 (if (file-exists? dst)
952 (format (current-error-port) "warning: ~a exists\n" dst)
954 (find-files (string-append package path) #:stat stat)))
959 (define (cups-server-bin-directory extensions)
960 "Return the CUPS ServerBin directory, containing binaries for CUPS and all
961 extensions that it uses."
962 (union-directory "cups-server-bin" extensions
964 '("/lib/cups" "/share/ppd" "/share/cups")))
966 (define (cups-shepherd-service config)
967 "Return a list of <shepherd-service> for CONFIG."
968 (let* ((cupsd.conf-str
970 ((opaque-cups-configuration? config)
971 (opaque-cups-configuration-cupsd.conf config))
973 (with-output-to-string
975 (serialize-configuration config
976 cups-configuration-fields))))))
979 ((opaque-cups-configuration? config)
980 (opaque-cups-configuration-cups-files.conf config))
982 (with-output-to-string
984 (serialize-configuration
985 (cups-configuration-files-configuration config)
986 files-configuration-fields))))))
987 (cups (if (opaque-cups-configuration? config)
988 (opaque-cups-configuration-cups config)
989 (cups-configuration-cups config)))
991 (cups-server-bin-directory
994 ((opaque-cups-configuration? config)
995 (opaque-cups-configuration-extensions config))
997 (cups-configuration-extensions config))))))
998 ;;"SetEnv PATH " server-bin "/bin" "\n"
1000 (plain-file "cupsd.conf" cupsd.conf-str))
1005 "CacheDir /var/cache/cups\n"
1006 "StateDir /var/run/cups\n"
1007 "DataDir " server-bin "/share/cups" "\n"
1008 "ServerBin " server-bin "/lib/cups" "\n")))
1009 (list (shepherd-service
1010 (documentation "Run the CUPS print server.")
1012 (requirement '(networking))
1013 (start #~(make-forkexec-constructor
1014 (list (string-append #$cups "/sbin/cupsd")
1015 "-f" "-c" #$cupsd.conf "-s" #$cups-files.conf)))
1016 (stop #~(make-kill-destructor))))))
1018 (define cups-service-type
1019 (service-type (name 'cups)
1021 (list (service-extension shepherd-root-service-type
1022 cups-shepherd-service)
1023 (service-extension activation-service-type
1024 (const %cups-activation))
1025 (service-extension account-service-type
1026 (const %cups-accounts))))
1028 ;; Extensions consist of lists of packages (representing CUPS
1029 ;; drivers, etc) that we just concatenate.
1032 ;; Add extension packages by augmenting the cups-configuration
1033 ;; 'extensions' field.
1035 (lambda (config extensions)
1037 ((cups-configuration? config)
1041 (append (cups-configuration-extensions config)
1044 (opaque-cups-configuration
1047 (append (opaque-cups-configuration-extensions config)
1050 (default-value (cups-configuration))
1052 "Run the CUPS print server.")))
1054 ;; A little helper to make it easier to document all those fields.
1055 (define (generate-cups-documentation)
1056 (generate-documentation
1057 `((cups-configuration
1058 ,cups-configuration-fields
1059 (files-configuration files-configuration)
1060 (policies policy-configuration)
1061 (location-access-controls location-access-controls))
1062 (files-configuration ,files-configuration-fields)
1063 (policy-configuration
1064 ,policy-configuration-fields
1065 (operation-access-controls operation-access-controls))
1066 (location-access-controls
1067 ,location-access-control-fields
1068 (method-access-controls method-access-controls))
1069 (operation-access-controls ,operation-access-control-fields)
1070 (method-access-controls ,method-access-control-fields))
1071 'cups-configuration))