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. @code{@@ACL} maps to
296 the printer's requesting-user-name-allowed or requesting-user-name-denied
297 values. @code{@@OWNER} maps to the job's owner. @code{@@SYSTEM} maps to the
298 groups listed for the @code{system-group} field of the @code{files-config}
299 configuration, which is reified into the @code{cups-files.conf(5)} file.
300 Other possible elements of the access list include specific user names, and
301 @code{@@@var{group}} to indicate members of a specific group. The access list
302 may also be simply @code{all} or @code{default}.")
304 (string (string-join '("job-name" "job-originating-host-name"
305 "job-originating-user-name" "phone")))
306 "Specifies the list of job values to make private, or @code{all},
307 @code{default}, or @code{none}.")
309 (subscription-private-access
310 (string "@OWNER @SYSTEM")
311 "Specifies an access list for a subscription's private values.
312 @code{@@ACL} maps to the printer's requesting-user-name-allowed or
313 requesting-user-name-denied values. @code{@@OWNER} maps to the job's owner.
314 @code{@@SYSTEM} maps to the groups listed for the @code{system-group} field of
315 the @code{files-config} configuration, which is reified into the
316 @code{cups-files.conf(5)} file. Other possible elements of the access list
317 include specific user names, and @code{@@@var{group}} to indicate members of a
318 specific group. The access list may also be simply @code{all} or
320 (subscription-private-values
321 (string (string-join '("notify-events" "notify-pull-method"
322 "notify-recipient-uri" "notify-subscriber-user-name"
325 "Specifies the list of job values to make private, or @code{all},
326 @code{default}, or @code{none}.")
329 (operation-access-control-list '())
330 "Access control by IPP operation."))
332 (define (serialize-policy-configuration x)
333 (format #t "<Policy ~a>\n" (policy-configuration-name x))
334 (serialize-configuration
336 (filter (lambda (field)
337 (not (eq? (configuration-field-name field) 'name)))
338 policy-configuration-fields))
339 (format #t "</Policy>\n"))
341 (define (policy-configuration-list? x)
342 (and (list? x) (and-map policy-configuration? x)))
343 (define (serialize-policy-configuration-list field-name x)
344 (for-each serialize-policy-configuration x))
346 (define (log-location? x)
350 (define (serialize-log-location field-name x)
352 (serialize-file-name field-name x)
353 (serialize-field field-name x)))
355 (define-configuration files-configuration
357 (log-location "/var/log/cups/access_log")
358 "Defines the access log filename. Specifying a blank filename disables
359 access log generation. The value @code{stderr} causes log entries to be sent
360 to the standard error file when the scheduler is running in the foreground, or
361 to the system log daemon when run in the background. The value @code{syslog}
362 causes log entries to be sent to the system log daemon. The server name may
363 be included in filenames using the string @code{%s}, as in
364 @code{/var/log/cups/%s-access_log}.")
366 (file-name "/var/cache/cups")
367 "Where CUPS should cache data.")
370 "Specifies the permissions for all configuration files that the scheduler
373 Note that the permissions for the printers.conf file are currently masked to
374 only allow access from the scheduler user (typically root). This is done
375 because printer device URIs sometimes contain sensitive authentication
376 information that should not be generally known on the system. There is no way
377 to disable this security feature.")
378 ;; Not specifying data-dir and server-bin options as we handle these
379 ;; manually. For document-root, the CUPS package has that path
382 (log-location "/var/log/cups/error_log")
383 "Defines the error log filename. Specifying a blank filename disables
384 access log generation. The value @code{stderr} causes log entries to be sent
385 to the standard error file when the scheduler is running in the foreground, or
386 to the system log daemon when run in the background. The value @code{syslog}
387 causes log entries to be sent to the system log daemon. The server name may
388 be included in filenames using the string @code{%s}, as in
389 @code{/var/log/cups/%s-error_log}.")
391 (string "all -browse")
392 "Specifies which errors are fatal, causing the scheduler to exit. The kind
398 All of the errors below are fatal.
400 Browsing initialization errors are fatal, for example failed connections to
403 Configuration file syntax errors are fatal.
405 Listen or Port errors are fatal, except for IPv6 failures on the loopback or
406 @code{any} addresses.
408 Log file creation or write errors are fatal.
410 Bad startup file permissions are fatal, for example shared TLS certificate and
411 key files with world-read permissions.
415 "Specifies whether the file pseudo-device can be used for new printer
416 queues. The URI @url{file:///dev/null} is always allowed.")
419 "Specifies the group name or ID that will be used when executing external
423 "Specifies the permissions for all log files that the scheduler writes.")
425 (log-location "/var/log/cups/page_log")
426 "Defines the page log filename. Specifying a blank filename disables
427 access log generation. The value @code{stderr} causes log entries to be sent
428 to the standard error file when the scheduler is running in the foreground, or
429 to the system log daemon when run in the background. The value @code{syslog}
430 causes log entries to be sent to the system log daemon. The server name may
431 be included in filenames using the string @code{%s}, as in
432 @code{/var/log/cups/%s-page_log}.")
435 "Specifies the username that is associated with unauthenticated accesses by
436 clients claiming to be the root user. The default is @code{remroot}.")
438 (file-name "/var/spool/cups")
439 "Specifies the directory that contains print jobs and other HTTP request
443 "Specifies the level of security sandboxing that is applied to print
444 filters, backends, and other child processes of the scheduler; either
445 @code{relaxed} or @code{strict}. This directive is currently only
446 used/supported on macOS.")
448 (file-name "/etc/cups/ssl")
449 "Specifies the location of TLS certificates and private keys. CUPS will
450 look for public and private keys in this directory: a @code{.crt} files for
451 PEM-encoded certificates and corresponding @code{.key} files for PEM-encoded
454 (file-name "/etc/cups")
455 "Specifies the directory containing the server configuration files.")
458 "Specifies whether the scheduler calls fsync(2) after writing configuration
461 (space-separated-string-list '("lpadmin" "wheel" "root"))
462 "Specifies the group(s) to use for @code{@@SYSTEM} group authentication.")
464 (file-name "/var/spool/cups/tmp")
465 "Specifies the directory where temporary files are stored.")
468 "Specifies the user name or ID that is used when running external
471 (string "variable value")
472 "Set the specified environment variable to be passed to child processes."))
474 (define (serialize-files-configuration field-name val)
477 (define (environment-variables? vars)
478 (space-separated-string-list? vars))
479 (define (serialize-environment-variables field-name vars)
481 (serialize-space-separated-string-list field-name vars)))
483 (define (package-list? val)
484 (and (list? val) (and-map package? val)))
485 (define (serialize-package-list field-name val)
488 (define-configuration cups-configuration
493 (package-list (list brlaser cups-filters epson-inkjet-printer-escpr
494 foomatic-filters hplip-minimal splix))
495 "Drivers and other extensions to the CUPS package.")
497 (files-configuration (files-configuration))
498 "Configuration of where to write logs, what directories to use for print
499 spools, and related privileged configuration parameters.")
501 (access-log-level 'actions)
502 "Specifies the logging level for the AccessLog file. The @code{config}
503 level logs when printers and classes are added, deleted, or modified and when
504 configuration files are accessed or updated. The @code{actions} level logs
505 when print jobs are submitted, held, released, modified, or canceled, and any
506 of the conditions for @code{config}. The @code{all} level logs all
510 "Specifies whether to purge job history data automatically when it is no
511 longer required for quotas.")
512 (browse-dns-sd-sub-types
513 (comma-separated-string-list (list "_cups"))
514 "Specifies a list of DNS-SD sub-types to advertise for each shared printer.
515 For example, @samp{\"_cups\" \"_print\"} will tell network clients that both
516 CUPS sharing and IPP Everywhere are supported.")
517 (browse-local-protocols
518 (browse-local-protocols 'dnssd)
519 "Specifies which protocols to use for local printer sharing.")
522 "Specifies whether the CUPS web interface is advertised.")
525 "Specifies whether shared printers are advertised.")
528 "Specifies the security classification of the server.
529 Any valid banner name can be used, including \"classified\", \"confidential\",
530 \"secret\", \"topsecret\", and \"unclassified\", or the banner can be omitted
531 to disable secure printing functions.")
534 "Specifies whether users may override the classification (cover page) of
535 individual print jobs using the @code{job-sheets} option.")
537 (default-auth-type 'Basic)
538 "Specifies the default type of authentication to use.")
540 (default-encryption 'Required)
541 "Specifies whether encryption will be used for authenticated requests.")
544 "Specifies the default language to use for text and web content.")
547 "Specifies the default paper size for new print queues. @samp{\"Auto\"}
548 uses a locale-specific default, while @samp{\"None\"} specifies there is no
549 default paper size. Specific size names are typically @samp{\"Letter\"} or
553 "Specifies the default access policy to use.")
556 "Specifies whether local printers are shared by default.")
557 (dirty-clean-interval
558 (non-negative-integer 30)
559 "Specifies the delay for updating of configuration and state files, in
560 seconds. A value of 0 causes the update to happen as soon as possible,
561 typically within a few milliseconds.")
563 (error-policy 'stop-printer)
564 "Specifies what to do when an error occurs. Possible values are
565 @code{abort-job}, which will discard the failed print job; @code{retry-job},
566 which will retry the job at a later time; @code{retry-current-job}, which retries
567 the failed job immediately; and @code{stop-printer}, which stops the
570 (non-negative-integer 0)
571 "Specifies the maximum cost of filters that are run concurrently, which can
572 be used to minimize disk, memory, and CPU resource problems. A limit of 0
573 disables filter limiting. An average print to a non-PostScript printer needs
574 a filter limit of about 200. A PostScript printer needs about half
575 that (100). Setting the limit below these thresholds will effectively limit
576 the scheduler to printing a single job at any time.")
578 (non-negative-integer 0)
579 "Specifies the scheduling priority of filters that are run to print a job.
580 The nice value ranges from 0, the highest priority, to 19, the lowest
582 ;; Add this option if the package is built with Kerberos support.
585 ;; "Specifies the service name when using Kerberos authentication.")
587 (host-name-lookups #f)
588 "Specifies whether to do reverse lookups on connecting clients.
589 The @code{double} setting causes @code{cupsd} to verify that the hostname
590 resolved from the address matches one of the addresses returned for that
591 hostname. Double lookups also prevent clients with unregistered addresses
592 from connecting to your server. Only set this option to @code{#t} or
593 @code{double} if absolutely required.")
594 ;; Add this option if the package is built with launchd/systemd support.
595 ;; (idle-exit-timeout
596 ;; (non-negative-integer 60)
597 ;; "Specifies the length of time to wait before shutting down due to
598 ;; inactivity. Note: Only applicable when @code{cupsd} is run on-demand
599 ;; (e.g., with @code{-l}).")
601 (non-negative-integer 30)
602 "Specifies the number of seconds to wait before killing the filters and
603 backend associated with a canceled or held job.")
605 (non-negative-integer 30)
606 "Specifies the interval between retries of jobs in seconds. This is
607 typically used for fax queues but can also be used with normal print queues
608 whose error policy is @code{retry-job} or @code{retry-current-job}.")
610 (non-negative-integer 5)
611 "Specifies the number of retries that are done for jobs. This is typically
612 used for fax queues but can also be used with normal print queues whose error
613 policy is @code{retry-job} or @code{retry-current-job}.")
616 "Specifies whether to support HTTP keep-alive connections.")
618 (non-negative-integer 30)
619 "Specifies how long an idle client connection remains open, in seconds.")
621 (non-negative-integer 0)
622 "Specifies the maximum size of print files, IPP requests, and HTML form
623 data. A limit of 0 disables the limit check.")
625 (multiline-string-list '("localhost:631" "/var/run/cups/cups.sock"))
626 "Listens on the specified interfaces for connections. Valid values are of
627 the form @var{address}:@var{port}, where @var{address} is either an IPv6
628 address enclosed in brackets, an IPv4 address, or @code{*} to indicate all
629 addresses. Values can also be file names of local UNIX domain sockets. The
630 Listen directive is similar to the Port directive but allows you to restrict
631 access to specific interfaces or networks.")
633 (non-negative-integer 128)
634 "Specifies the number of pending connections that will be allowed. This
635 normally only affects very busy servers that have reached the MaxClients
636 limit, but can also be triggered by large numbers of simultaneous connections.
637 When the limit is reached, the operating system will refuse additional
638 connections until the scheduler can accept the pending ones.")
639 (location-access-controls
640 (location-access-control-list
641 (list (location-access-control
643 (access-controls '("Order allow,deny"
645 (location-access-control
647 (access-controls '("Order allow,deny"
649 (location-access-control
651 (access-controls '("Order allow,deny"
653 "Require user @SYSTEM"
654 "Allow localhost")))))
655 "Specifies a set of additional access controls.")
657 (non-negative-integer 100)
658 "Specifies the number of debugging messages that are retained for logging
659 if an error occurs in a print job. Debug messages are logged regardless of
660 the LogLevel setting.")
663 "Specifies the level of logging for the ErrorLog file. The value
664 @code{none} stops all logging while @code{debug2} logs everything.")
666 (log-time-format 'standard)
667 "Specifies the format of the date and time in the log files. The value
668 @code{standard} logs whole seconds while @code{usecs} logs microseconds.")
670 (non-negative-integer 100)
671 "Specifies the maximum number of simultaneous clients that are allowed by
673 (max-clients-per-host
674 (non-negative-integer 100)
675 "Specifies the maximum number of simultaneous clients that are allowed from
678 (non-negative-integer 9999)
679 "Specifies the maximum number of copies that a user can print of each
682 (non-negative-integer 0)
683 "Specifies the maximum time a job may remain in the @code{indefinite} hold
684 state before it is canceled. A value of 0 disables cancellation of held
687 (non-negative-integer 500)
688 "Specifies the maximum number of simultaneous jobs that are allowed. Set
689 to 0 to allow an unlimited number of jobs.")
690 (max-jobs-per-printer
691 (non-negative-integer 0)
692 "Specifies the maximum number of simultaneous jobs that are allowed per
693 printer. A value of 0 allows up to MaxJobs jobs per printer.")
695 (non-negative-integer 0)
696 "Specifies the maximum number of simultaneous jobs that are allowed per
697 user. A value of 0 allows up to MaxJobs jobs per user.")
699 (non-negative-integer 10800)
700 "Specifies the maximum time a job may take to print before it is canceled,
701 in seconds. Set to 0 to disable cancellation of \"stuck\" jobs.")
703 (non-negative-integer 1048576)
704 "Specifies the maximum size of the log files before they are rotated, in
705 bytes. The value 0 disables log rotation.")
706 (multiple-operation-timeout
707 (non-negative-integer 300)
708 "Specifies the maximum amount of time to allow between files in a multiple
709 file print job, in seconds.")
712 "Specifies the format of PageLog lines. Sequences beginning with
713 percent (@samp{%}) characters are replaced with the corresponding information,
714 while all other characters are copied literally. The following percent
715 sequences are recognized:
719 insert a single percent character
721 insert the value of the specified IPP attribute
723 insert the number of copies for the current page
725 insert the current page number
727 insert the current date and time in common log format
731 insert the printer name
736 A value of the empty string disables page logging. The string @code{%p %u %j
737 %T %P %C %@{job-billing@} %@{job-originating-host-name@} %@{job-name@}
738 %@{media@} %@{sides@}} creates a page log with the standard items.")
739 (environment-variables
740 (environment-variables '())
741 "Passes the specified environment variable(s) to child processes; a list of
744 (policy-configuration-list
745 (list (policy-configuration
749 (operation-access-control
752 Send-URI Hold-Job Release-Job Restart-Job Purge-Jobs
753 Cancel-Job Close-Job Cancel-My-Jobs Set-Job-Attributes
754 Create-Job-Subscription Renew-Subscription
755 Cancel-Subscription Get-Notifications
756 Reprocess-Job Cancel-Current-Job Suspend-Current-Job
757 Resume-Job CUPS-Move-Job Validate-Job
759 (access-controls '("Require user @OWNER @SYSTEM"
760 "Order deny,allow")))
761 (operation-access-control
765 Resume-Printer Set-Printer-Attributes Enable-Printer
766 Disable-Printer Pause-Printer-After-Current-Job
767 Hold-New-Jobs Release-Held-New-Jobs Deactivate-Printer
768 Activate-Printer Restart-Printer Shutdown-Printer
769 Startup-Printer Promote-Job Schedule-Job-After
770 CUPS-Authenticate-Job CUPS-Add-Printer
771 CUPS-Delete-Printer CUPS-Add-Class CUPS-Delete-Class
772 CUPS-Accept-Jobs CUPS-Reject-Jobs CUPS-Set-Default))
773 (access-controls '("AuthType Basic"
774 "Require user @SYSTEM"
775 "Order deny,allow")))
776 (operation-access-control
778 (access-controls '("Order deny,allow"))))))))
779 "Specifies named access control policies.")
782 (non-negative-integer 631)
783 "Listens to the specified port number for connections.")
785 (boolean-or-non-negative-integer 86400)
786 "Specifies whether job files (documents) are preserved after a job is
787 printed. If a numeric value is specified, job files are preserved for the
788 indicated number of seconds after printing. Otherwise a boolean value applies
790 (preserve-job-history
791 (boolean-or-non-negative-integer #t)
792 "Specifies whether the job history is preserved after a job is printed.
793 If a numeric value is specified, the job history is preserved for the
794 indicated number of seconds after printing. If @code{#t}, the job history is
795 preserved until the MaxJobs limit is reached.")
797 (non-negative-integer 30)
798 "Specifies the amount of time to wait for job completion before restarting
802 "Specifies the maximum amount of memory to use when converting documents into bitmaps for a printer.")
804 (string "root@localhost.localdomain")
805 "Specifies the email address of the server administrator.")
807 (host-name-list-or-* '*)
808 "The ServerAlias directive is used for HTTP Host header validation when
809 clients connect to the scheduler from external interfaces. Using the special
810 name @code{*} can expose your system to known browser-based DNS rebinding
811 attacks, even when accessing sites through a firewall. If the auto-discovery
812 of alternate names does not work, we recommend listing each alternate name
813 with a ServerAlias directive instead of using @code{*}.")
816 "Specifies the fully-qualified host name of the server.")
818 (server-tokens 'Minimal)
819 "Specifies what information is included in the Server header of HTTP
820 responses. @code{None} disables the Server header. @code{ProductOnly}
821 reports @code{CUPS}. @code{Major} reports @code{CUPS 2}. @code{Minor}
822 reports @code{CUPS 2.0}. @code{Minimal} reports @code{CUPS 2.0.0}. @code{OS}
823 reports @code{CUPS 2.0.0 (@var{uname})} where @var{uname} is the output of the
824 @code{uname} command. @code{Full} reports @code{CUPS 2.0.0 (@var{uname})
827 (multiline-string-list '())
828 "Listens on the specified interfaces for encrypted connections. Valid
829 values are of the form @var{address}:@var{port}, where @var{address} is either
830 an IPv6 address enclosed in brackets, an IPv4 address, or @code{*} to indicate
834 "Sets encryption options. By default, CUPS only supports encryption
835 using TLS v1.0 or higher using known secure cipher suites. Security is
836 reduced when @code{Allow} options are used, and enhanced when @code{Deny}
837 options are used. The @code{AllowRC4} option enables the 128-bit RC4 cipher
838 suites, which are required for some older clients. The @code{AllowSSL3} option
839 enables SSL v3.0, which is required for some older clients that do not support
840 TLS v1.0. The @code{DenyCBC} option disables all CBC cipher suites. The
841 @code{DenyTLS1.0} option disables TLS v1.0 support - this sets the minimum
842 protocol version to TLS v1.1.")
845 (non-negative-integer 631)
846 "Listens on the specified port for encrypted connections.")
849 "Specifies whether the scheduler requires clients to strictly adhere to the
850 IPP specifications.")
852 (non-negative-integer 300)
853 "Specifies the HTTP request timeout, in seconds.")
856 "Specifies whether the web interface is enabled."))
858 (define-configuration opaque-cups-configuration
864 "Drivers and other extensions to the CUPS package.")
866 (string (configuration-missing-field 'opaque-cups-configuration
868 "The contents of the @code{cupsd.conf} to use.")
870 (string (configuration-missing-field 'opaque-cups-configuration
872 "The contents of the @code{cups-files.conf} to use."))
874 (define %cups-activation
876 (with-imported-modules (source-module-closure '((gnu build activation)
879 (use-modules (gnu build activation)
881 (define (build-subject parameters)
884 (let ((k (car pair)) (v (cdr pair)))
885 (define (escape-char str chr)
886 (string-join (string-split str chr) (string #\\ chr)))
887 (string-append "/" k "="
888 (escape-char (escape-char v #\=) #\/))))
889 (filter (lambda (pair) (cdr pair)) parameters))))
890 (define* (create-self-signed-certificate-if-absent
891 #:key private-key public-key (owner (getpwnam "root"))
892 (common-name (gethostname))
893 (organization-name "Guix")
894 (organization-unit-name "Default Self-Signed Certificate")
895 (subject-parameters `(("CN" . ,common-name)
896 ("O" . ,organization-name)
897 ("OU" . ,organization-unit-name)))
898 (subject (build-subject subject-parameters)))
899 ;; Note that by default, OpenSSL outputs keys in PEM format. This
901 (unless (file-exists? private-key)
903 ((zero? (system* (string-append #$openssl "/bin/openssl")
904 "genrsa" "-out" private-key "2048"))
905 (chown private-key (passwd:uid owner) (passwd:gid owner))
906 (chmod private-key #o400))
908 (format (current-error-port)
909 "Failed to create private key at ~a.\n" private-key))))
910 (unless (file-exists? public-key)
912 ((zero? (system* (string-append #$openssl "/bin/openssl")
913 "req" "-new" "-x509" "-key" private-key
914 "-out" public-key "-days" "3650"
915 "-batch" "-subj" subject))
916 (chown public-key (passwd:uid owner) (passwd:gid owner))
917 (chmod public-key #o444))
919 (format (current-error-port)
920 "Failed to create public key at ~a.\n" public-key)))))
921 (let ((user (getpwnam "lp")))
922 (mkdir-p/perms "/var/run/cups" user #o755)
923 (mkdir-p/perms "/var/spool/cups" user #o755)
924 (mkdir-p/perms "/var/spool/cups/tmp" user #o755)
925 (mkdir-p/perms "/var/log/cups" user #o755)
926 (mkdir-p/perms "/var/cache/cups" user #o770)
927 (mkdir-p/perms "/etc/cups" user #o755)
928 (mkdir-p/perms "/etc/cups/ssl" user #o700)
929 ;; This certificate is used for HTTPS connections to the CUPS web
931 (create-self-signed-certificate-if-absent
932 #:private-key "/etc/cups/ssl/localhost.key"
933 #:public-key "/etc/cups/ssl/localhost.crt"
934 #:owner (getpwnam "root")
935 #:common-name (format #f "CUPS service on ~a" (gethostname)))))))
937 (define (union-directory name packages paths)
940 (with-imported-modules '((guix build utils))
942 (use-modules (guix build utils)
951 (let* ((tail (substring src (string-length package)))
952 (dst (string-append #$output tail)))
953 (mkdir-p (dirname dst))
954 ;; CUPS currently symlinks in some data from cups-filters
955 ;; to its output dir. Probably we should stop doing this
956 ;; and instead rely only on the CUPS service to union the
957 ;; relevant set of CUPS packages.
958 (if (file-exists? dst)
959 (format (current-error-port) "warning: ~a exists\n" dst)
961 (find-files (string-append package path) #:stat stat)))
966 (define (cups-server-bin-directory extensions)
967 "Return the CUPS ServerBin directory, containing binaries for CUPS and all
968 extensions that it uses."
969 (union-directory "cups-server-bin" extensions
971 '("/lib/cups" "/share/ppd" "/share/cups")))
973 (define (cups-shepherd-service config)
974 "Return a list of <shepherd-service> for CONFIG."
975 (let* ((cupsd.conf-str
977 ((opaque-cups-configuration? config)
978 (opaque-cups-configuration-cupsd.conf config))
980 (with-output-to-string
982 (serialize-configuration config
983 cups-configuration-fields))))))
986 ((opaque-cups-configuration? config)
987 (opaque-cups-configuration-cups-files.conf config))
989 (with-output-to-string
991 (serialize-configuration
992 (cups-configuration-files-configuration config)
993 files-configuration-fields))))))
994 (cups (if (opaque-cups-configuration? config)
995 (opaque-cups-configuration-cups config)
996 (cups-configuration-cups config)))
998 (cups-server-bin-directory
1001 ((opaque-cups-configuration? config)
1002 (opaque-cups-configuration-extensions config))
1004 (cups-configuration-extensions config))))))
1005 ;;"SetEnv PATH " server-bin "/bin" "\n"
1007 (plain-file "cupsd.conf" cupsd.conf-str))
1012 "CacheDir /var/cache/cups\n"
1013 "StateDir /var/run/cups\n"
1014 "DataDir " server-bin "/share/cups" "\n"
1015 "ServerBin " server-bin "/lib/cups" "\n")))
1016 (list (shepherd-service
1017 (documentation "Run the CUPS print server.")
1019 (requirement '(networking))
1020 (start #~(make-forkexec-constructor
1021 (list (string-append #$cups "/sbin/cupsd")
1022 "-f" "-c" #$cupsd.conf "-s" #$cups-files.conf)))
1023 (stop #~(make-kill-destructor))))))
1025 (define cups-service-type
1026 (service-type (name 'cups)
1028 (list (service-extension shepherd-root-service-type
1029 cups-shepherd-service)
1030 (service-extension activation-service-type
1031 (const %cups-activation))
1032 (service-extension account-service-type
1033 (const %cups-accounts))))
1035 ;; Extensions consist of lists of packages (representing CUPS
1036 ;; drivers, etc) that we just concatenate.
1039 ;; Add extension packages by augmenting the cups-configuration
1040 ;; 'extensions' field.
1042 (lambda (config extensions)
1044 ((cups-configuration? config)
1048 (append (cups-configuration-extensions config)
1051 (opaque-cups-configuration
1054 (append (opaque-cups-configuration-extensions config)
1057 (default-value (cups-configuration))
1059 "Run the CUPS print server.")))
1061 ;; A little helper to make it easier to document all those fields.
1062 (define (generate-cups-documentation)
1063 (generate-documentation
1064 `((cups-configuration
1065 ,cups-configuration-fields
1066 (files-configuration files-configuration)
1067 (policies policy-configuration)
1068 (location-access-controls location-access-controls))
1069 (files-configuration ,files-configuration-fields)
1070 (policy-configuration
1071 ,policy-configuration-fields
1072 (operation-access-controls operation-access-controls))
1073 (location-access-controls
1074 ,location-access-control-fields
1075 (method-access-controls method-access-controls))
1076 (operation-access-controls ,operation-access-control-fields)
1077 (method-access-controls ,method-access-control-fields))
1078 'cups-configuration))