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>
7 ;;; Copyright © 2021 Maxime Devos <maximedevos@telenet.be>
9 ;;; This file is part of GNU Guix.
11 ;;; GNU Guix is free software; you can redistribute it and/or modify it
12 ;;; under the terms of the GNU General Public License as published by
13 ;;; the Free Software Foundation; either version 3 of the License, or (at
14 ;;; your option) any later version.
16 ;;; GNU Guix is distributed in the hope that it will be useful, but
17 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;;; GNU General Public License for more details.
21 ;;; You should have received a copy of the GNU General Public License
22 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
24 (define-module (gnu services cups)
25 #:use-module (gnu services)
26 #:use-module (gnu services shepherd)
27 #:use-module (gnu services configuration)
28 #:use-module (gnu system shadow)
29 #:use-module (gnu packages admin)
30 #:use-module (gnu packages cups)
31 #:use-module (gnu packages tls)
32 #:use-module (guix packages)
33 #:use-module (guix records)
34 #:use-module (guix gexp)
35 #:use-module (guix modules)
36 #:use-module (ice-9 match)
37 #:use-module ((srfi srfi-1) #:select (append-map find))
38 #:export (cups-service-type
40 opaque-cups-configuration
44 location-access-control
45 operation-access-control
46 method-access-control))
50 ;;; Service defininition for the CUPS printing system.
54 (define %cups-accounts
56 ;; The "lp" group should already exist; try to reuse it.
58 (and (user-group? group)
59 (string=? (user-group-name group) "lp")))
61 (user-group (name "lp") (system? #t)))
62 (user-group (name "lpadmin") (system? #t))
67 (comment "System user for invoking printing helper programs")
68 (home-directory "/var/empty")
69 (shell (file-append shadow "/sbin/nologin")))))
71 (define (uglify-field-name field-name)
72 (let ((str (symbol->string field-name)))
75 (string-split (if (string-suffix? "?" str)
76 (substring str 0 (1- (string-length str)))
80 (define (serialize-field field-name val)
81 (format #t "~a ~a\n" (uglify-field-name field-name) val))
83 (define (serialize-string field-name val)
84 (serialize-field field-name val))
86 (define (multiline-string-list? val)
89 (and (string? x) (not (string-index x #\space))))
91 (define (serialize-multiline-string-list field-name val)
92 (for-each (lambda (str) (serialize-field field-name str)) val))
94 (define (comma-separated-string-list? val)
97 (and (string? x) (not (string-index x #\,))))
99 (define (serialize-comma-separated-string-list field-name val)
100 (serialize-field field-name (string-join val ",")))
102 (define (space-separated-string-list? val)
105 (and (string? x) (not (string-index x #\space))))
107 (define (serialize-space-separated-string-list field-name val)
108 (serialize-field field-name (string-join val " ")))
110 (define (space-separated-symbol-list? val)
111 (and (list? val) (and-map symbol? val)))
112 (define (serialize-space-separated-symbol-list field-name val)
113 (serialize-field field-name (string-join (map symbol->string val) " ")))
115 (define (file-name? val)
117 (string-prefix? "/" val)))
118 (define (serialize-file-name field-name val)
119 (serialize-string field-name val))
121 (define (serialize-boolean field-name val)
122 (serialize-string field-name (if val "yes" "no")))
124 (define (non-negative-integer? val)
125 (and (exact-integer? val) (not (negative? val))))
126 (define (serialize-non-negative-integer field-name val)
127 (serialize-field field-name val))
129 (define-syntax define-enumerated-field-type
131 (define (id-append ctx . parts)
132 (datum->syntax ctx (apply symbol-append (map syntax->datum parts))))
134 ((_ name (option ...))
136 (define (#,(id-append #'name #'name #'?) x)
137 (memq x '(option ...)))
138 (define (#,(id-append #'name #'serialize- #'name) field-name val)
139 (serialize-field field-name val)))))))
141 (define-enumerated-field-type access-log-level
142 (config actions all))
143 (define-enumerated-field-type browse-local-protocols
145 (define-enumerated-field-type default-auth-type
147 (define-enumerated-field-type default-encryption
148 (Never IfRequested Required))
149 (define-enumerated-field-type error-policy
150 (abort-job retry-job retry-current-job stop-printer))
151 (define-enumerated-field-type log-level
152 (none emerg alert crit error warn notice info debug debug2))
153 (define-enumerated-field-type log-time-format
155 (define-enumerated-field-type server-tokens
156 (None ProductOnly Major Minor Minimal OS Full))
157 (define-enumerated-field-type method
158 (DELETE GET HEAD OPTIONS POST PUT TRACE))
159 (define-enumerated-field-type sandboxing
162 (define (method-list? val)
163 (and (list? val) (and-map method? val)))
164 (define (serialize-method-list field-name val)
165 (serialize-field field-name (string-join (map symbol->string val) " ")))
167 (define (host-name-lookups? val)
168 (memq val '(#f #t 'double)))
169 (define (serialize-host-name-lookups field-name val)
170 (serialize-field field-name
171 (match val (#f "No") (#t "Yes") ('double "Double"))))
173 (define (host-name-list-or-*? x)
175 (and (list? x) (and-map string? x))))
176 (define (serialize-host-name-list-or-* field-name val)
177 (serialize-field field-name (match val
179 (names (string-join names " ")))))
181 (define (boolean-or-non-negative-integer? x)
182 (or (boolean? x) (non-negative-integer? x)))
183 (define (serialize-boolean-or-non-negative-integer field-name x)
185 (serialize-boolean field-name x)
186 (serialize-non-negative-integer field-name x)))
188 (define (ssl-options? x)
190 (and-map (lambda (elt) (memq elt '(AllowRC4
194 (define (serialize-ssl-options field-name val)
195 (serialize-field field-name
198 (opts (string-join (map symbol->string opts) " ")))))
200 (define (serialize-access-control x)
203 (define (serialize-access-control-list field-name val)
204 (for-each serialize-access-control val))
205 (define (access-control-list? val)
206 (and (list? val) (and-map string? val)))
208 (define-configuration operation-access-control
210 (space-separated-symbol-list '())
211 "IPP operations to which this access control applies.")
213 (access-control-list '())
214 "Access control directives, as a list of strings. Each string should be one directive, such as \"Order allow,deny\"."))
216 (define-configuration method-access-control
219 "If @code{#t}, apply access controls to all methods except the listed
220 methods. Otherwise apply to only the listed methods.")
223 "Methods to which this access control applies.")
225 (access-control-list '())
226 "Access control directives, as a list of strings. Each string should be one directive, such as \"Order allow,deny\"."))
228 (define (serialize-operation-access-control x)
229 (format #t "<Limit ~a>\n"
230 (string-join (map symbol->string
231 (operation-access-control-operations x)) " "))
232 (serialize-configuration
234 (filter (lambda (field)
235 (not (eq? (configuration-field-name field) 'operations)))
236 operation-access-control-fields))
237 (format #t "</Limit>\n"))
239 (define (serialize-method-access-control x)
240 (let ((limit (if (method-access-control-reverse? x) "LimitExcept" "Limit")))
241 (format #t "<~a ~a>\n" limit
242 (string-join (map symbol->string
243 (method-access-control-methods x)) " "))
244 (serialize-configuration
246 (filter (lambda (field)
247 (case (configuration-field-name field)
248 ((reverse? methods) #f)
250 method-access-control-fields))
251 (format #t "</~a>\n" limit)))
253 (define (operation-access-control-list? val)
254 (and (list? val) (and-map operation-access-control? val)))
255 (define (serialize-operation-access-control-list field-name val)
256 (for-each serialize-operation-access-control val))
258 (define (method-access-control-list? val)
259 (and (list? val) (and-map method-access-control? val)))
260 (define (serialize-method-access-control-list field-name val)
261 (for-each serialize-method-access-control val))
263 (define-configuration location-access-control
265 (file-name (configuration-missing-field 'location-access-control 'path))
266 "Specifies the URI path to which the access control applies.")
268 (access-control-list '())
269 "Access controls for all access to this path, in the same format as the
270 @code{access-controls} of @code{operation-access-control}.")
271 (method-access-controls
272 (method-access-control-list '())
273 "Access controls for method-specific access to this path."))
275 (define (serialize-location-access-control x)
276 (format #t "<Location ~a>\n" (location-access-control-path x))
277 (serialize-configuration
279 (filter (lambda (field)
280 (not (eq? (configuration-field-name field) 'path)))
281 location-access-control-fields))
282 (format #t "</Location>\n"))
284 (define (location-access-control-list? val)
285 (and (list? val) (and-map location-access-control? val)))
286 (define (serialize-location-access-control-list field-name val)
287 (for-each serialize-location-access-control val))
289 (define-configuration policy-configuration
291 (string (configuration-missing-field 'policy-configuration 'name))
292 "Name of the policy.")
294 (string "@OWNER @SYSTEM")
295 "Specifies an access list for a job's private values.
296 @code{@@ACL} maps to the printer's requesting-user-name-allowed or
297 requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner.
298 @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of
299 the @code{files-configuration}, which is reified into the
300 @code{cups-files.conf(5)} file.
301 Other possible elements of the access list include specific user names, and
302 @code{@@@var{group}} to indicate members of a specific group. The access list
303 may also be simply @code{all} or @code{default}.")
305 (string (string-join '("job-name" "job-originating-host-name"
306 "job-originating-user-name" "phone")))
307 "Specifies the list of job values to make private, or @code{all},
308 @code{default}, or @code{none}.")
310 (subscription-private-access
311 (string "@OWNER @SYSTEM")
312 "Specifies an access list for a subscription's private values.
313 @code{@@ACL} maps to the printer's requesting-user-name-allowed or
314 requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner.
315 @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of
316 the @code{files-configuration}, which is reified into the
317 @code{cups-files.conf(5)} file.
318 Other possible elements of the access list include specific user names, and
319 @code{@@@var{group}} to indicate members of a specific group. The access list
320 may also be simply @code{all} or @code{default}.")
321 (subscription-private-values
322 (string (string-join '("notify-events" "notify-pull-method"
323 "notify-recipient-uri" "notify-subscriber-user-name"
326 "Specifies the list of job values to make private, or @code{all},
327 @code{default}, or @code{none}.")
330 (operation-access-control-list '())
331 "Access control by IPP operation."))
333 (define (serialize-policy-configuration x)
334 (format #t "<Policy ~a>\n" (policy-configuration-name x))
335 (serialize-configuration
337 (filter (lambda (field)
338 (not (eq? (configuration-field-name field) 'name)))
339 policy-configuration-fields))
340 (format #t "</Policy>\n"))
342 (define (policy-configuration-list? x)
343 (and (list? x) (and-map policy-configuration? x)))
344 (define (serialize-policy-configuration-list field-name x)
345 (for-each serialize-policy-configuration x))
347 (define (log-location? x)
351 (define (serialize-log-location field-name x)
353 (serialize-file-name field-name x)
354 (serialize-field field-name x)))
356 (define-configuration files-configuration
358 (log-location "/var/log/cups/access_log")
359 "Defines the access log filename. Specifying a blank filename disables
360 access log generation. The value @code{stderr} causes log entries to be sent
361 to the standard error file when the scheduler is running in the foreground, or
362 to the system log daemon when run in the background. The value @code{syslog}
363 causes log entries to be sent to the system log daemon. The server name may
364 be included in filenames using the string @code{%s}, as in
365 @code{/var/log/cups/%s-access_log}.")
367 (file-name "/var/cache/cups")
368 "Where CUPS should cache data.")
371 "Specifies the permissions for all configuration files that the scheduler
374 Note that the permissions for the printers.conf file are currently masked to
375 only allow access from the scheduler user (typically root). This is done
376 because printer device URIs sometimes contain sensitive authentication
377 information that should not be generally known on the system. There is no way
378 to disable this security feature.")
379 ;; Not specifying data-dir and server-bin options as we handle these
380 ;; manually. For document-root, the CUPS package has that path
383 (log-location "/var/log/cups/error_log")
384 "Defines the error log filename. Specifying a blank filename disables
385 access log generation. The value @code{stderr} causes log entries to be sent
386 to the standard error file when the scheduler is running in the foreground, or
387 to the system log daemon when run in the background. The value @code{syslog}
388 causes log entries to be sent to the system log daemon. The server name may
389 be included in filenames using the string @code{%s}, as in
390 @code{/var/log/cups/%s-error_log}.")
392 (string "all -browse")
393 "Specifies which errors are fatal, causing the scheduler to exit. The kind
399 All of the errors below are fatal.
401 Browsing initialization errors are fatal, for example failed connections to
404 Configuration file syntax errors are fatal.
406 Listen or Port errors are fatal, except for IPv6 failures on the loopback or
407 @code{any} addresses.
409 Log file creation or write errors are fatal.
411 Bad startup file permissions are fatal, for example shared TLS certificate and
412 key files with world-read permissions.
416 "Specifies whether the file pseudo-device can be used for new printer
417 queues. The URI @url{file:///dev/null} is always allowed.")
420 "Specifies the group name or ID that will be used when executing external
424 "Specifies the group name or ID that will be used for log files.")
427 "Specifies the permissions for all log files that the scheduler writes.")
429 (log-location "/var/log/cups/page_log")
430 "Defines the page log filename. Specifying a blank filename disables
431 access log generation. The value @code{stderr} causes log entries to be sent
432 to the standard error file when the scheduler is running in the foreground, or
433 to the system log daemon when run in the background. The value @code{syslog}
434 causes log entries to be sent to the system log daemon. The server name may
435 be included in filenames using the string @code{%s}, as in
436 @code{/var/log/cups/%s-page_log}.")
439 "Specifies the username that is associated with unauthenticated accesses by
440 clients claiming to be the root user. The default is @code{remroot}.")
442 (file-name "/var/spool/cups")
443 "Specifies the directory that contains print jobs and other HTTP request
447 "Specifies the level of security sandboxing that is applied to print
448 filters, backends, and other child processes of the scheduler; either
449 @code{relaxed} or @code{strict}. This directive is currently only
450 used/supported on macOS.")
452 (file-name "/etc/cups/ssl")
453 "Specifies the location of TLS certificates and private keys. CUPS will
454 look for public and private keys in this directory: a @code{.crt} files for
455 PEM-encoded certificates and corresponding @code{.key} files for PEM-encoded
458 (file-name "/etc/cups")
459 "Specifies the directory containing the server configuration files.")
462 "Specifies whether the scheduler calls fsync(2) after writing configuration
465 (space-separated-string-list '("lpadmin" "wheel" "root"))
466 "Specifies the group(s) to use for @code{@@SYSTEM} group authentication.")
468 (file-name "/var/spool/cups/tmp")
469 "Specifies the directory where temporary files are stored.")
472 "Specifies the user name or ID that is used when running external
475 (string "variable value")
476 "Set the specified environment variable to be passed to child processes."))
478 (define (serialize-files-configuration field-name val)
481 (define (environment-variables? vars)
482 (space-separated-string-list? vars))
483 (define (serialize-environment-variables field-name vars)
485 (serialize-space-separated-string-list field-name vars)))
487 (define (package-list? val)
488 (and (list? val) (and-map file-like? val)))
489 (define (serialize-package-list field-name val)
492 (define-configuration cups-configuration
497 (package-list (list brlaser cups-filters epson-inkjet-printer-escpr
498 foomatic-filters hplip-minimal splix))
499 "Drivers and other extensions to the CUPS package.")
501 (files-configuration (files-configuration))
502 "Configuration of where to write logs, what directories to use for print
503 spools, and related privileged configuration parameters.")
505 (access-log-level 'actions)
506 "Specifies the logging level for the AccessLog file. The @code{config}
507 level logs when printers and classes are added, deleted, or modified and when
508 configuration files are accessed or updated. The @code{actions} level logs
509 when print jobs are submitted, held, released, modified, or canceled, and any
510 of the conditions for @code{config}. The @code{all} level logs all
514 "Specifies whether to purge job history data automatically when it is no
515 longer required for quotas.")
516 (browse-dns-sd-sub-types
517 (comma-separated-string-list (list "_cups"))
518 "Specifies a list of DNS-SD sub-types to advertise for each shared printer.
519 For example, @samp{\"_cups\" \"_print\"} will tell network clients that both
520 CUPS sharing and IPP Everywhere are supported.")
521 (browse-local-protocols
522 (browse-local-protocols 'dnssd)
523 "Specifies which protocols to use for local printer sharing.")
526 "Specifies whether the CUPS web interface is advertised.")
529 "Specifies whether shared printers are advertised.")
532 "Specifies the security classification of the server.
533 Any valid banner name can be used, including \"classified\", \"confidential\",
534 \"secret\", \"topsecret\", and \"unclassified\", or the banner can be omitted
535 to disable secure printing functions.")
538 "Specifies whether users may override the classification (cover page) of
539 individual print jobs using the @code{job-sheets} option.")
541 (default-auth-type 'Basic)
542 "Specifies the default type of authentication to use.")
544 (default-encryption 'Required)
545 "Specifies whether encryption will be used for authenticated requests.")
548 "Specifies the default language to use for text and web content.")
551 "Specifies the default paper size for new print queues. @samp{\"Auto\"}
552 uses a locale-specific default, while @samp{\"None\"} specifies there is no
553 default paper size. Specific size names are typically @samp{\"Letter\"} or
557 "Specifies the default access policy to use.")
560 "Specifies whether local printers are shared by default.")
561 (dirty-clean-interval
562 (non-negative-integer 30)
563 "Specifies the delay for updating of configuration and state files, in
564 seconds. A value of 0 causes the update to happen as soon as possible,
565 typically within a few milliseconds.")
567 (error-policy 'stop-printer)
568 "Specifies what to do when an error occurs. Possible values are
569 @code{abort-job}, which will discard the failed print job; @code{retry-job},
570 which will retry the job at a later time; @code{retry-current-job}, which retries
571 the failed job immediately; and @code{stop-printer}, which stops the
574 (non-negative-integer 0)
575 "Specifies the maximum cost of filters that are run concurrently, which can
576 be used to minimize disk, memory, and CPU resource problems. A limit of 0
577 disables filter limiting. An average print to a non-PostScript printer needs
578 a filter limit of about 200. A PostScript printer needs about half
579 that (100). Setting the limit below these thresholds will effectively limit
580 the scheduler to printing a single job at any time.")
582 (non-negative-integer 0)
583 "Specifies the scheduling priority of filters that are run to print a job.
584 The nice value ranges from 0, the highest priority, to 19, the lowest
586 ;; Add this option if the package is built with Kerberos support.
589 ;; "Specifies the service name when using Kerberos authentication.")
591 (host-name-lookups #f)
592 "Specifies whether to do reverse lookups on connecting clients.
593 The @code{double} setting causes @code{cupsd} to verify that the hostname
594 resolved from the address matches one of the addresses returned for that
595 hostname. Double lookups also prevent clients with unregistered addresses
596 from connecting to your server. Only set this option to @code{#t} or
597 @code{double} if absolutely required.")
598 ;; Add this option if the package is built with launchd/systemd support.
599 ;; (idle-exit-timeout
600 ;; (non-negative-integer 60)
601 ;; "Specifies the length of time to wait before shutting down due to
602 ;; inactivity. Note: Only applicable when @code{cupsd} is run on-demand
603 ;; (e.g., with @code{-l}).")
605 (non-negative-integer 30)
606 "Specifies the number of seconds to wait before killing the filters and
607 backend associated with a canceled or held job.")
609 (non-negative-integer 30)
610 "Specifies the interval between retries of jobs in seconds. This is
611 typically used for fax queues but can also be used with normal print queues
612 whose error policy is @code{retry-job} or @code{retry-current-job}.")
614 (non-negative-integer 5)
615 "Specifies the number of retries that are done for jobs. This is typically
616 used for fax queues but can also be used with normal print queues whose error
617 policy is @code{retry-job} or @code{retry-current-job}.")
620 "Specifies whether to support HTTP keep-alive connections.")
622 (non-negative-integer 0)
623 "Specifies the maximum size of print files, IPP requests, and HTML form
624 data. A limit of 0 disables the limit check.")
626 (multiline-string-list '("localhost:631" "/var/run/cups/cups.sock"))
627 "Listens on the specified interfaces for connections. Valid values are of
628 the form @var{address}:@var{port}, where @var{address} is either an IPv6
629 address enclosed in brackets, an IPv4 address, or @code{*} to indicate all
630 addresses. Values can also be file names of local UNIX domain sockets. The
631 Listen directive is similar to the Port directive but allows you to restrict
632 access to specific interfaces or networks.")
634 (non-negative-integer 128)
635 "Specifies the number of pending connections that will be allowed. This
636 normally only affects very busy servers that have reached the MaxClients
637 limit, but can also be triggered by large numbers of simultaneous connections.
638 When the limit is reached, the operating system will refuse additional
639 connections until the scheduler can accept the pending ones.")
640 (location-access-controls
641 (location-access-control-list
642 (list (location-access-control
644 (access-controls '("Order allow,deny"
646 (location-access-control
648 (access-controls '("Order allow,deny"
650 (location-access-control
652 (access-controls '("Order allow,deny"
654 "Require user @SYSTEM"
655 "Allow localhost")))))
656 "Specifies a set of additional access controls.")
658 (non-negative-integer 100)
659 "Specifies the number of debugging messages that are retained for logging
660 if an error occurs in a print job. Debug messages are logged regardless of
661 the LogLevel setting.")
664 "Specifies the level of logging for the ErrorLog file. The value
665 @code{none} stops all logging while @code{debug2} logs everything.")
667 (log-time-format 'standard)
668 "Specifies the format of the date and time in the log files. The value
669 @code{standard} logs whole seconds while @code{usecs} logs microseconds.")
671 (non-negative-integer 100)
672 "Specifies the maximum number of simultaneous clients that are allowed by
674 (max-clients-per-host
675 (non-negative-integer 100)
676 "Specifies the maximum number of simultaneous clients that are allowed from
679 (non-negative-integer 9999)
680 "Specifies the maximum number of copies that a user can print of each
683 (non-negative-integer 0)
684 "Specifies the maximum time a job may remain in the @code{indefinite} hold
685 state before it is canceled. A value of 0 disables cancellation of held
688 (non-negative-integer 500)
689 "Specifies the maximum number of simultaneous jobs that are allowed. Set
690 to 0 to allow an unlimited number of jobs.")
691 (max-jobs-per-printer
692 (non-negative-integer 0)
693 "Specifies the maximum number of simultaneous jobs that are allowed per
694 printer. A value of 0 allows up to MaxJobs jobs per printer.")
696 (non-negative-integer 0)
697 "Specifies the maximum number of simultaneous jobs that are allowed per
698 user. A value of 0 allows up to MaxJobs jobs per user.")
700 (non-negative-integer 10800)
701 "Specifies the maximum time a job may take to print before it is canceled,
702 in seconds. Set to 0 to disable cancellation of \"stuck\" jobs.")
704 (non-negative-integer 1048576)
705 "Specifies the maximum size of the log files before they are rotated, in
706 bytes. The value 0 disables log rotation.")
707 (multiple-operation-timeout
708 (non-negative-integer 900)
709 "Specifies the maximum amount of time to allow between files in a multiple
710 file print job, in seconds.")
713 "Specifies the format of PageLog lines. Sequences beginning with
714 percent (@samp{%}) characters are replaced with the corresponding information,
715 while all other characters are copied literally. The following percent
716 sequences are recognized:
720 insert a single percent character
722 insert the value of the specified IPP attribute
724 insert the number of copies for the current page
726 insert the current page number
728 insert the current date and time in common log format
732 insert the printer name
737 A value of the empty string disables page logging. The string @code{%p %u %j
738 %T %P %C %@{job-billing@} %@{job-originating-host-name@} %@{job-name@}
739 %@{media@} %@{sides@}} creates a page log with the standard items.")
740 (environment-variables
741 (environment-variables '())
742 "Passes the specified environment variable(s) to child processes; a list of
745 (policy-configuration-list
746 (list (policy-configuration
750 (operation-access-control
753 Send-URI Hold-Job Release-Job Restart-Job Purge-Jobs
754 Cancel-Job Close-Job Cancel-My-Jobs Set-Job-Attributes
755 Create-Job-Subscription Renew-Subscription
756 Cancel-Subscription Get-Notifications
757 Reprocess-Job Cancel-Current-Job Suspend-Current-Job
758 Resume-Job CUPS-Move-Job Validate-Job
760 (access-controls '("Require user @OWNER @SYSTEM"
761 "Order deny,allow")))
762 (operation-access-control
766 Resume-Printer Set-Printer-Attributes Enable-Printer
767 Disable-Printer Pause-Printer-After-Current-Job
768 Hold-New-Jobs Release-Held-New-Jobs Deactivate-Printer
769 Activate-Printer Restart-Printer Shutdown-Printer
770 Startup-Printer Promote-Job Schedule-Job-After
771 CUPS-Authenticate-Job CUPS-Add-Printer
772 CUPS-Delete-Printer CUPS-Add-Class CUPS-Delete-Class
773 CUPS-Accept-Jobs CUPS-Reject-Jobs CUPS-Set-Default))
774 (access-controls '("AuthType Basic"
775 "Require user @SYSTEM"
776 "Order deny,allow")))
777 (operation-access-control
779 (access-controls '("Order deny,allow"))))))))
780 "Specifies named access control policies.")
783 (non-negative-integer 631)
784 "Listens to the specified port number for connections.")
786 (boolean-or-non-negative-integer 86400)
787 "Specifies whether job files (documents) are preserved after a job is
788 printed. If a numeric value is specified, job files are preserved for the
789 indicated number of seconds after printing. Otherwise a boolean value applies
791 (preserve-job-history
792 (boolean-or-non-negative-integer #t)
793 "Specifies whether the job history is preserved after a job is printed.
794 If a numeric value is specified, the job history is preserved for the
795 indicated number of seconds after printing. If @code{#t}, the job history is
796 preserved until the MaxJobs limit is reached.")
798 (non-negative-integer 30)
799 "Specifies the amount of time to wait for job completion before restarting
803 "Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.")
805 (string "root@localhost.localdomain")
806 "Specifies the email address of the server administrator.")
808 (host-name-list-or-* '*)
809 "The ServerAlias directive is used for HTTP Host header validation when
810 clients connect to the scheduler from external interfaces. Using the special
811 name @code{*} can expose your system to known browser-based DNS rebinding
812 attacks, even when accessing sites through a firewall. If the auto-discovery
813 of alternate names does not work, we recommend listing each alternate name
814 with a ServerAlias directive instead of using @code{*}.")
817 "Specifies the fully-qualified host name of the server.")
819 (server-tokens 'Minimal)
820 "Specifies what information is included in the Server header of HTTP
821 responses. @code{None} disables the Server header. @code{ProductOnly}
822 reports @code{CUPS}. @code{Major} reports @code{CUPS 2}. @code{Minor}
823 reports @code{CUPS 2.0}. @code{Minimal} reports @code{CUPS 2.0.0}. @code{OS}
824 reports @code{CUPS 2.0.0 (@var{uname})} where @var{uname} is the output of the
825 @code{uname} command. @code{Full} reports @code{CUPS 2.0.0 (@var{uname})
828 (multiline-string-list '())
829 "Listens on the specified interfaces for encrypted connections. Valid
830 values are of the form @var{address}:@var{port}, where @var{address} is either
831 an IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate
835 "Sets encryption options. By default, CUPS only supports encryption
836 using TLS v1.0 or higher using known secure cipher suites. Security is
837 reduced when @code{Allow} options are used, and enhanced when @code{Deny}
838 options are used. The @code{AllowRC4} option enables the 128-bit RC4 cipher
839 suites, which are required for some older clients. The @code{AllowSSL3} option
840 enables SSL v3.0, which is required for some older clients that do not support
841 TLS v1.0. The @code{DenyCBC} option disables all CBC cipher suites. The
842 @code{DenyTLS1.0} option disables TLS v1.0 support - this sets the minimum
843 protocol version to TLS v1.1.")
846 (non-negative-integer 631)
847 "Listens on the specified port for encrypted connections.")
850 "Specifies whether the scheduler requires clients to strictly adhere to the
851 IPP specifications.")
853 (non-negative-integer 900)
854 "Specifies the HTTP request timeout, in seconds.")
857 "Specifies whether the web interface is enabled."))
859 (define-configuration opaque-cups-configuration
865 "Drivers and other extensions to the CUPS package.")
867 (string (configuration-missing-field 'opaque-cups-configuration
869 "The contents of the @code{cupsd.conf} to use.")
871 (string (configuration-missing-field 'opaque-cups-configuration
873 "The contents of the @code{cups-files.conf} to use."))
875 (define %cups-activation
877 (with-imported-modules (source-module-closure '((gnu build activation)
880 (use-modules (gnu build activation)
882 (define (build-subject parameters)
885 (let ((k (car pair)) (v (cdr pair)))
886 (define (escape-char str chr)
887 (string-join (string-split str chr) (string #\\ chr)))
888 (string-append "/" k "="
889 (escape-char (escape-char v #\=) #\/))))
890 (filter (lambda (pair) (cdr pair)) parameters))))
891 (define* (create-self-signed-certificate-if-absent
892 #:key private-key public-key (owner (getpwnam "root"))
893 (common-name (gethostname))
894 (organization-name "Guix")
895 (organization-unit-name "Default Self-Signed Certificate")
896 (subject-parameters `(("CN" . ,common-name)
897 ("O" . ,organization-name)
898 ("OU" . ,organization-unit-name)))
899 (subject (build-subject subject-parameters)))
900 ;; Note that by default, OpenSSL outputs keys in PEM format. This
902 (unless (file-exists? private-key)
904 ((zero? (system* (string-append #$openssl "/bin/openssl")
905 "genrsa" "-out" private-key "2048"))
906 (chown private-key (passwd:uid owner) (passwd:gid owner))
907 (chmod private-key #o400))
909 (format (current-error-port)
910 "Failed to create private key at ~a.\n" private-key))))
911 (unless (file-exists? public-key)
913 ((zero? (system* (string-append #$openssl "/bin/openssl")
914 "req" "-new" "-x509" "-key" private-key
915 "-out" public-key "-days" "3650"
916 "-batch" "-subj" subject))
917 (chown public-key (passwd:uid owner) (passwd:gid owner))
918 (chmod public-key #o444))
920 (format (current-error-port)
921 "Failed to create public key at ~a.\n" public-key)))))
922 (let ((user (getpwnam "lp")))
923 (mkdir-p/perms "/var/run/cups" user #o755)
924 (mkdir-p/perms "/var/spool/cups" user #o755)
925 (mkdir-p/perms "/var/spool/cups/tmp" user #o755)
926 (mkdir-p/perms "/var/log/cups" user #o755)
927 (mkdir-p/perms "/var/cache/cups" user #o770)
928 (mkdir-p/perms "/etc/cups" user #o755)
929 (mkdir-p/perms "/etc/cups/ssl" user #o700)
930 ;; This certificate is used for HTTPS connections to the CUPS web
932 (create-self-signed-certificate-if-absent
933 #:private-key "/etc/cups/ssl/localhost.key"
934 #:public-key "/etc/cups/ssl/localhost.crt"
935 #:owner (getpwnam "root")
936 #:common-name (format #f "CUPS service on ~a" (gethostname)))))))
938 (define (union-directory name packages paths)
941 (with-imported-modules '((guix build utils))
943 (use-modules (guix build utils)
952 (let* ((tail (substring src (string-length package)))
953 (dst (string-append #$output tail)))
954 (mkdir-p (dirname dst))
955 ;; CUPS currently symlinks in some data from cups-filters
956 ;; to its output dir. Probably we should stop doing this
957 ;; and instead rely only on the CUPS service to union the
958 ;; relevant set of CUPS packages.
959 (if (file-exists? dst)
960 (format (current-error-port) "warning: ~a exists\n" dst)
962 (find-files (string-append package path) #:stat stat)))
967 (define (cups-server-bin-directory extensions)
968 "Return the CUPS ServerBin directory, containing binaries for CUPS and all
969 extensions that it uses."
970 (union-directory "cups-server-bin" extensions
972 '("/lib/cups" "/share/ppd" "/share/cups")))
974 (define (cups-shepherd-service config)
975 "Return a list of <shepherd-service> for CONFIG."
976 (let* ((cupsd.conf-str
978 ((opaque-cups-configuration? config)
979 (opaque-cups-configuration-cupsd.conf config))
981 (with-output-to-string
983 (serialize-configuration config
984 cups-configuration-fields))))))
987 ((opaque-cups-configuration? config)
988 (opaque-cups-configuration-cups-files.conf config))
990 (with-output-to-string
992 (serialize-configuration
993 (cups-configuration-files-configuration config)
994 files-configuration-fields))))))
995 (cups (if (opaque-cups-configuration? config)
996 (opaque-cups-configuration-cups config)
997 (cups-configuration-cups config)))
999 (cups-server-bin-directory
1002 ((opaque-cups-configuration? config)
1003 (opaque-cups-configuration-extensions config))
1005 (cups-configuration-extensions config))))))
1006 ;;"SetEnv PATH " server-bin "/bin" "\n"
1008 (plain-file "cupsd.conf" cupsd.conf-str))
1013 "CacheDir /var/cache/cups\n"
1014 "StateDir /var/run/cups\n"
1015 "DataDir " server-bin "/share/cups" "\n"
1016 "ServerBin " server-bin "/lib/cups" "\n")))
1017 (list (shepherd-service
1018 (documentation "Run the CUPS print server.")
1020 (requirement '(networking))
1021 (start #~(make-forkexec-constructor
1022 (list (string-append #$cups "/sbin/cupsd")
1023 "-f" "-c" #$cupsd.conf "-s" #$cups-files.conf)))
1024 (stop #~(make-kill-destructor))))))
1026 (define cups-service-type
1027 (service-type (name 'cups)
1029 (list (service-extension shepherd-root-service-type
1030 cups-shepherd-service)
1031 (service-extension activation-service-type
1032 (const %cups-activation))
1033 (service-extension account-service-type
1034 (const %cups-accounts))))
1036 ;; Extensions consist of lists of packages (representing CUPS
1037 ;; drivers, etc) that we just concatenate.
1040 ;; Add extension packages by augmenting the cups-configuration
1041 ;; 'extensions' field.
1043 (lambda (config extensions)
1045 ((cups-configuration? config)
1049 (append (cups-configuration-extensions config)
1052 (opaque-cups-configuration
1055 (append (opaque-cups-configuration-extensions config)
1058 (default-value (cups-configuration))
1060 "Run the CUPS print server.")))
1062 ;; A little helper to make it easier to document all those fields.
1063 (define (generate-cups-documentation)
1064 (generate-documentation
1065 `((cups-configuration
1066 ,cups-configuration-fields
1067 (files-configuration files-configuration)
1068 (policies policy-configuration)
1069 (location-access-controls location-access-controls))
1070 (files-configuration ,files-configuration-fields)
1071 (policy-configuration
1072 ,policy-configuration-fields
1073 (operation-access-controls operation-access-controls))
1074 (location-access-controls
1075 ,location-access-control-fields
1076 (method-access-controls method-access-controls))
1077 (operation-access-controls ,operation-access-control-fields)
1078 (method-access-controls ,method-access-control-fields))
1079 'cups-configuration))