2014-04-14 15:26:48 +01:00
|
|
|
{ config, lib, pkgs, ... }:
|
2009-03-06 12:26:46 +00:00
|
|
|
|
2014-04-14 15:26:48 +01:00
|
|
|
with lib;
|
2007-04-02 18:31:58 +01:00
|
|
|
|
|
|
|
let
|
|
|
|
|
2016-08-25 16:48:35 +01:00
|
|
|
inherit (pkgs) cups cups-pk-helper cups-filters gutenprint;
|
2008-11-07 13:37:28 +00:00
|
|
|
|
2009-08-28 00:16:09 +01:00
|
|
|
cfg = config.services.printing;
|
2008-11-07 13:37:28 +00:00
|
|
|
|
2016-01-17 00:34:39 +00:00
|
|
|
avahiEnabled = config.services.avahi.enable;
|
|
|
|
polkitEnabled = config.security.polkit.enable;
|
|
|
|
|
2012-05-25 16:51:33 +01:00
|
|
|
additionalBackends = pkgs.runCommand "additional-cups-backends" { }
|
|
|
|
''
|
|
|
|
mkdir -p $out
|
2016-01-24 07:29:02 +00:00
|
|
|
if [ ! -e ${cups.out}/lib/cups/backend/smb ]; then
|
2012-05-25 16:51:33 +01:00
|
|
|
mkdir -p $out/lib/cups/backend
|
2010-12-15 22:36:39 +00:00
|
|
|
ln -sv ${pkgs.samba}/bin/smbspool $out/lib/cups/backend/smb
|
2010-04-25 19:27:00 +01:00
|
|
|
fi
|
2010-04-19 11:54:39 +01:00
|
|
|
|
|
|
|
# Provide support for printing via HTTPS.
|
2016-01-24 07:29:02 +00:00
|
|
|
if [ ! -e ${cups.out}/lib/cups/backend/https ]; then
|
2012-05-25 16:51:33 +01:00
|
|
|
mkdir -p $out/lib/cups/backend
|
2016-01-24 07:29:02 +00:00
|
|
|
ln -sv ${cups.out}/lib/cups/backend/ipp $out/lib/cups/backend/https
|
2010-04-25 19:27:00 +01:00
|
|
|
fi
|
2010-04-19 11:54:39 +01:00
|
|
|
'';
|
|
|
|
|
2008-11-07 13:37:28 +00:00
|
|
|
# Here we can enable additional backends, filters, etc. that are not
|
|
|
|
# part of CUPS itself, e.g. the SMB backend is part of Samba. Since
|
2016-01-24 07:29:02 +00:00
|
|
|
# we can't update ${cups.out}/lib/cups itself, we create a symlink tree
|
2008-11-07 13:37:28 +00:00
|
|
|
# here and add the additional programs. The ServerBin directive in
|
|
|
|
# cupsd.conf tells cupsd to use this tree.
|
2010-04-15 16:47:07 +01:00
|
|
|
bindir = pkgs.buildEnv {
|
|
|
|
name = "cups-progs";
|
2016-01-17 00:38:52 +00:00
|
|
|
paths =
|
2016-08-25 16:48:35 +01:00
|
|
|
[ cups.out additionalBackends cups-filters pkgs.ghostscript ]
|
2016-01-17 01:05:02 +00:00
|
|
|
++ optional cfg.gutenprint gutenprint
|
2016-01-17 00:38:52 +00:00
|
|
|
++ cfg.drivers;
|
2017-07-02 03:47:14 +01:00
|
|
|
pathsToLink = [ "/lib" "/share/cups" "/bin" ];
|
2010-04-25 19:27:00 +01:00
|
|
|
postBuild = cfg.bindirCmds;
|
2014-11-24 16:40:03 +00:00
|
|
|
ignoreCollisions = true;
|
2010-04-15 16:47:07 +01:00
|
|
|
};
|
2007-04-02 18:31:58 +01:00
|
|
|
|
2016-01-17 01:10:29 +00:00
|
|
|
writeConf = name: text: pkgs.writeTextFile {
|
|
|
|
inherit name text;
|
|
|
|
destination = "/etc/cups/${name}";
|
|
|
|
};
|
|
|
|
|
|
|
|
cupsFilesFile = writeConf "cups-files.conf" ''
|
|
|
|
SystemGroup root wheel
|
|
|
|
|
|
|
|
ServerBin ${bindir}/lib/cups
|
|
|
|
DataDir ${bindir}/share/cups
|
2017-03-12 17:09:39 +00:00
|
|
|
DocumentRoot ${cups.out}/share/doc/cups
|
2016-01-17 01:10:29 +00:00
|
|
|
|
|
|
|
AccessLog syslog
|
|
|
|
ErrorLog syslog
|
|
|
|
PageLog syslog
|
|
|
|
|
|
|
|
TempDir ${cfg.tempDir}
|
|
|
|
|
|
|
|
# User and group used to run external programs, including
|
|
|
|
# those that actually send the job to the printer. Note that
|
|
|
|
# Udev sets the group of printer devices to `lp', so we want
|
|
|
|
# these programs to run as `lp' as well.
|
|
|
|
User cups
|
|
|
|
Group lp
|
|
|
|
|
|
|
|
${cfg.extraFilesConf}
|
|
|
|
'';
|
|
|
|
|
|
|
|
cupsdFile = writeConf "cupsd.conf" ''
|
|
|
|
${concatMapStrings (addr: ''
|
|
|
|
Listen ${addr}
|
|
|
|
'') cfg.listenAddresses}
|
|
|
|
Listen /var/run/cups/cups.sock
|
|
|
|
|
2016-12-14 02:23:16 +00:00
|
|
|
SetEnv PATH /var/lib/cups/path/lib/cups/filter:/var/lib/cups/path/bin
|
2016-01-17 01:10:29 +00:00
|
|
|
|
|
|
|
DefaultShared ${if cfg.defaultShared then "Yes" else "No"}
|
|
|
|
|
|
|
|
Browsing ${if cfg.browsing then "Yes" else "No"}
|
|
|
|
|
|
|
|
WebInterface ${if cfg.webInterface then "Yes" else "No"}
|
|
|
|
|
|
|
|
${cfg.extraConf}
|
|
|
|
'';
|
|
|
|
|
|
|
|
browsedFile = writeConf "cups-browsed.conf" cfg.browsedConf;
|
|
|
|
|
2016-01-17 01:12:11 +00:00
|
|
|
rootdir = pkgs.buildEnv {
|
|
|
|
name = "cups-progs";
|
|
|
|
paths = [
|
|
|
|
cupsFilesFile
|
|
|
|
cupsdFile
|
|
|
|
(writeConf "client.conf" cfg.clientConf)
|
|
|
|
(writeConf "snmp.conf" cfg.snmpConf)
|
|
|
|
] ++ optional avahiEnabled browsedFile
|
|
|
|
++ optional cfg.gutenprint gutenprint
|
|
|
|
++ cfg.drivers;
|
|
|
|
pathsToLink = [ "/etc/cups" ];
|
|
|
|
ignoreCollisions = true;
|
|
|
|
};
|
|
|
|
|
2009-10-12 17:36:19 +01:00
|
|
|
in
|
2007-04-02 18:31:58 +01:00
|
|
|
|
2009-10-12 17:36:19 +01:00
|
|
|
{
|
2007-04-02 18:31:58 +01:00
|
|
|
|
2009-10-12 17:36:19 +01:00
|
|
|
###### interface
|
|
|
|
|
|
|
|
options = {
|
|
|
|
services.printing = {
|
|
|
|
|
|
|
|
enable = mkOption {
|
2013-10-30 16:37:45 +00:00
|
|
|
type = types.bool;
|
2009-10-12 17:36:19 +01:00
|
|
|
default = false;
|
|
|
|
description = ''
|
|
|
|
Whether to enable printing support through the CUPS daemon.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2014-04-24 23:30:12 +01:00
|
|
|
listenAddresses = mkOption {
|
|
|
|
type = types.listOf types.str;
|
|
|
|
default = [ "127.0.0.1:631" ];
|
|
|
|
example = [ "*:631" ];
|
|
|
|
description = ''
|
|
|
|
A list of addresses and ports on which to listen.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2009-10-12 17:36:19 +01:00
|
|
|
bindirCmds = mkOption {
|
2013-10-30 16:37:45 +00:00
|
|
|
type = types.lines;
|
|
|
|
internal = true;
|
2009-10-12 17:36:19 +01:00
|
|
|
default = "";
|
|
|
|
description = ''
|
|
|
|
Additional commands executed while creating the directory
|
|
|
|
containing the CUPS server binaries.
|
|
|
|
'';
|
|
|
|
};
|
2007-04-02 18:31:58 +01:00
|
|
|
|
2015-05-04 21:32:35 +01:00
|
|
|
defaultShared = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
|
|
|
description = ''
|
|
|
|
Specifies whether local printers are shared by default.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2015-05-10 19:47:50 +01:00
|
|
|
browsing = mkOption {
|
2015-05-04 21:32:35 +01:00
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
|
|
|
description = ''
|
|
|
|
Specifies whether shared printers are advertised.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
webInterface = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = true;
|
|
|
|
description = ''
|
|
|
|
Specifies whether the web interface is enabled.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2016-01-17 01:10:29 +00:00
|
|
|
extraFilesConf = mkOption {
|
2014-12-16 02:12:02 +00:00
|
|
|
type = types.lines;
|
|
|
|
default = "";
|
|
|
|
description = ''
|
2016-01-17 01:10:29 +00:00
|
|
|
Extra contents of the configuration file of the CUPS daemon
|
2014-12-16 02:12:02 +00:00
|
|
|
(<filename>cups-files.conf</filename>).
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2014-11-27 19:00:56 +00:00
|
|
|
extraConf = mkOption {
|
|
|
|
type = types.lines;
|
|
|
|
default = "";
|
|
|
|
example =
|
|
|
|
''
|
|
|
|
BrowsePoll cups.example.com
|
|
|
|
LogLevel debug
|
|
|
|
'';
|
|
|
|
description = ''
|
|
|
|
Extra contents of the configuration file of the CUPS daemon
|
|
|
|
(<filename>cupsd.conf</filename>).
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2014-06-11 20:52:53 +01:00
|
|
|
clientConf = mkOption {
|
|
|
|
type = types.lines;
|
|
|
|
default = "";
|
|
|
|
example =
|
|
|
|
''
|
|
|
|
ServerName server.example.com
|
|
|
|
Encryption Never
|
|
|
|
'';
|
|
|
|
description = ''
|
|
|
|
The contents of the client configuration.
|
|
|
|
(<filename>client.conf</filename>)
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2014-12-11 12:27:29 +00:00
|
|
|
browsedConf = mkOption {
|
|
|
|
type = types.lines;
|
|
|
|
default = "";
|
|
|
|
example =
|
|
|
|
''
|
|
|
|
BrowsePoll cups.example.com
|
|
|
|
'';
|
|
|
|
description = ''
|
|
|
|
The contents of the configuration. file of the CUPS Browsed daemon
|
|
|
|
(<filename>cups-browsed.conf</filename>)
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2015-08-13 09:12:52 +01:00
|
|
|
snmpConf = mkOption {
|
|
|
|
type = types.lines;
|
|
|
|
default = ''
|
|
|
|
Address @LOCAL
|
|
|
|
'';
|
|
|
|
description = ''
|
|
|
|
The contents of <filename>/etc/cups/snmp.conf</filename>. See "man
|
|
|
|
cups-snmp.conf" for a complete description.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2016-01-17 01:05:02 +00:00
|
|
|
gutenprint = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
|
|
|
description = ''
|
|
|
|
Whether to enable Gutenprint drivers for CUPS. This includes auto-updating
|
|
|
|
Gutenprint PPD files.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2010-04-15 16:47:07 +01:00
|
|
|
drivers = mkOption {
|
2013-10-30 16:37:45 +00:00
|
|
|
type = types.listOf types.path;
|
2016-01-17 00:38:52 +00:00
|
|
|
default = [];
|
2013-10-30 16:37:45 +00:00
|
|
|
example = literalExample "[ pkgs.splix ]";
|
2010-04-15 16:47:07 +01:00
|
|
|
description = ''
|
2014-11-23 16:51:55 +00:00
|
|
|
CUPS drivers to use. Drivers provided by CUPS, cups-filters, Ghostscript
|
2016-03-08 15:39:17 +00:00
|
|
|
and Samba are added unconditionally. For adding Gutenprint, see
|
|
|
|
<literal>gutenprint</literal>.
|
2010-04-15 16:47:07 +01:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2010-04-25 19:27:00 +01:00
|
|
|
tempDir = mkOption {
|
2013-10-30 16:37:45 +00:00
|
|
|
type = types.path;
|
2010-04-25 19:27:00 +01:00
|
|
|
default = "/tmp";
|
|
|
|
example = "/tmp/cups";
|
|
|
|
description = ''
|
|
|
|
CUPSd temporary directory.
|
|
|
|
'';
|
|
|
|
};
|
2009-10-12 17:36:19 +01:00
|
|
|
};
|
2009-02-22 16:07:05 +00:00
|
|
|
|
2009-10-12 17:36:19 +01:00
|
|
|
};
|
2009-02-22 16:07:05 +00:00
|
|
|
|
2010-04-25 19:27:00 +01:00
|
|
|
|
2009-10-12 17:36:19 +01:00
|
|
|
###### implementation
|
2009-07-15 10:06:36 +01:00
|
|
|
|
2009-10-12 17:36:19 +01:00
|
|
|
config = mkIf config.services.printing.enable {
|
2009-07-15 10:06:36 +01:00
|
|
|
|
2010-08-06 15:52:09 +01:00
|
|
|
users.extraUsers = singleton
|
|
|
|
{ name = "cups";
|
|
|
|
uid = config.ids.uids.cups;
|
|
|
|
group = "lp";
|
|
|
|
description = "CUPS printing services";
|
|
|
|
};
|
|
|
|
|
2016-04-16 18:18:07 +01:00
|
|
|
environment.systemPackages = [ cups.out ] ++ optional polkitEnabled cups-pk-helper;
|
2016-01-17 01:12:11 +00:00
|
|
|
environment.etc."cups".source = "/var/lib/cups";
|
2009-07-15 10:06:36 +01:00
|
|
|
|
2016-04-16 18:18:07 +01:00
|
|
|
services.dbus.packages = [ cups.out ] ++ optional polkitEnabled cups-pk-helper;
|
2009-11-04 22:44:21 +00:00
|
|
|
|
2010-08-06 15:52:09 +01:00
|
|
|
# Cups uses libusb to talk to printers, and does not use the
|
2010-06-07 22:09:27 +01:00
|
|
|
# linux kernel driver. If the driver is not in a black list, it
|
|
|
|
# gets loaded, and then cups cannot access the printers.
|
|
|
|
boot.blacklistedKernelModules = [ "usblp" ];
|
|
|
|
|
2016-04-16 08:07:48 +01:00
|
|
|
systemd.packages = [ cups.out ];
|
2009-03-06 12:26:46 +00:00
|
|
|
|
2015-04-28 19:37:34 +01:00
|
|
|
systemd.services.cups =
|
|
|
|
{ wantedBy = [ "multi-user.target" ];
|
2014-04-24 21:46:26 +01:00
|
|
|
wants = [ "network.target" ];
|
|
|
|
after = [ "network.target" ];
|
2009-10-12 17:36:19 +01:00
|
|
|
|
2016-04-16 18:18:07 +01:00
|
|
|
path = [ cups.out ];
|
2010-06-07 22:09:27 +01:00
|
|
|
|
2009-10-12 17:36:19 +01:00
|
|
|
preStart =
|
|
|
|
''
|
2009-03-06 12:26:46 +00:00
|
|
|
mkdir -m 0700 -p /var/cache/cups
|
|
|
|
mkdir -m 0700 -p /var/spool/cups
|
2010-04-25 19:27:00 +01:00
|
|
|
mkdir -m 0755 -p ${cfg.tempDir}
|
2009-03-06 12:26:46 +00:00
|
|
|
|
2016-01-17 01:12:11 +00:00
|
|
|
mkdir -m 0755 -p /var/lib/cups
|
|
|
|
# Backwards compatibility
|
|
|
|
if [ ! -L /etc/cups ]; then
|
|
|
|
mv /etc/cups/* /var/lib/cups
|
|
|
|
rmdir /etc/cups
|
|
|
|
ln -s /var/lib/cups /etc/cups
|
|
|
|
fi
|
|
|
|
# First, clean existing symlinks
|
|
|
|
if [ -n "$(ls /var/lib/cups)" ]; then
|
|
|
|
for i in /var/lib/cups/*; do
|
|
|
|
[ -L "$i" ] && rm "$i"
|
|
|
|
done
|
|
|
|
fi
|
|
|
|
# Then, populate it with static files
|
|
|
|
cd ${rootdir}/etc/cups
|
|
|
|
for i in *; do
|
|
|
|
[ ! -e "/var/lib/cups/$i" ] && ln -s "${rootdir}/etc/cups/$i" "/var/lib/cups/$i"
|
|
|
|
done
|
2016-12-14 02:23:16 +00:00
|
|
|
|
|
|
|
#update path reference
|
|
|
|
[ -L /var/lib/cups/path ] && \
|
|
|
|
rm /var/lib/cups/path
|
|
|
|
[ ! -e /var/lib/cups/path ] && \
|
|
|
|
ln -s ${bindir} /var/lib/cups/path
|
|
|
|
|
2016-01-17 01:05:02 +00:00
|
|
|
${optionalString cfg.gutenprint ''
|
2016-03-15 18:43:39 +00:00
|
|
|
if [ -d /var/lib/cups/ppd ]; then
|
|
|
|
${gutenprint}/bin/cups-genppdupdate -p /var/lib/cups/ppd
|
|
|
|
fi
|
2016-01-17 01:05:02 +00:00
|
|
|
''}
|
2009-10-12 17:36:19 +01:00
|
|
|
'';
|
2017-05-10 09:52:11 +01:00
|
|
|
|
|
|
|
serviceConfig.PrivateTmp = true;
|
2009-10-12 17:36:19 +01:00
|
|
|
};
|
|
|
|
|
2016-01-17 00:34:39 +00:00
|
|
|
systemd.services.cups-browsed = mkIf avahiEnabled
|
2015-08-04 15:40:02 +01:00
|
|
|
{ description = "CUPS Remote Printer Discovery";
|
2014-12-11 12:27:29 +00:00
|
|
|
|
|
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
wants = [ "cups.service" "avahi-daemon.service" ];
|
2015-12-21 16:31:09 +00:00
|
|
|
bindsTo = [ "cups.service" "avahi-daemon.service" ];
|
|
|
|
partOf = [ "cups.service" "avahi-daemon.service" ];
|
2014-12-11 12:27:29 +00:00
|
|
|
after = [ "cups.service" "avahi-daemon.service" ];
|
|
|
|
|
|
|
|
path = [ cups ];
|
|
|
|
|
2016-08-25 16:48:35 +01:00
|
|
|
serviceConfig.ExecStart = "${cups-filters}/bin/cups-browsed";
|
2014-12-11 12:27:29 +00:00
|
|
|
|
2016-01-17 01:10:29 +00:00
|
|
|
restartTriggers = [ browsedFile ];
|
2014-12-11 12:27:29 +00:00
|
|
|
};
|
|
|
|
|
2016-01-17 01:10:29 +00:00
|
|
|
services.printing.extraConf =
|
2014-12-16 02:12:02 +00:00
|
|
|
''
|
|
|
|
LogLevel info
|
|
|
|
|
2010-04-06 12:57:15 +01:00
|
|
|
DefaultAuthType Basic
|
|
|
|
|
|
|
|
<Location />
|
|
|
|
Order allow,deny
|
|
|
|
Allow localhost
|
|
|
|
</Location>
|
|
|
|
|
|
|
|
<Location /admin>
|
|
|
|
Order allow,deny
|
|
|
|
Allow localhost
|
|
|
|
</Location>
|
|
|
|
|
|
|
|
<Location /admin/conf>
|
|
|
|
AuthType Basic
|
|
|
|
Require user @SYSTEM
|
|
|
|
Order allow,deny
|
|
|
|
Allow localhost
|
|
|
|
</Location>
|
|
|
|
|
|
|
|
<Policy default>
|
|
|
|
<Limit Send-Document Send-URI Hold-Job Release-Job Restart-Job Purge-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>
|
|
|
|
Require user @OWNER @SYSTEM
|
|
|
|
Order deny,allow
|
|
|
|
</Limit>
|
|
|
|
|
|
|
|
<Limit Pause-Printer 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-Add-Printer CUPS-Delete-Printer CUPS-Add-Class CUPS-Delete-Class CUPS-Accept-Jobs CUPS-Reject-Jobs CUPS-Set-Default>
|
|
|
|
AuthType Basic
|
|
|
|
Require user @SYSTEM
|
|
|
|
Order deny,allow
|
|
|
|
</Limit>
|
|
|
|
|
|
|
|
<Limit Cancel-Job CUPS-Authenticate-Job>
|
|
|
|
Require user @OWNER @SYSTEM
|
|
|
|
Order deny,allow
|
|
|
|
</Limit>
|
|
|
|
|
|
|
|
<Limit All>
|
|
|
|
Order deny,allow
|
|
|
|
</Limit>
|
|
|
|
</Policy>
|
|
|
|
'';
|
|
|
|
|
2013-10-15 13:47:51 +01:00
|
|
|
security.pam.services.cups = {};
|
|
|
|
|
2009-10-12 17:36:19 +01:00
|
|
|
};
|
2007-04-02 18:31:58 +01:00
|
|
|
}
|