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