{ config, lib, pkgs, ... }: with lib; let inherit (pkgs) cups cups-pk-helper cups-filters; cfg = config.services.printing; avahiEnabled = config.services.avahi.enable; polkitEnabled = config.security.polkit.enable; additionalBackends = pkgs.runCommand "additional-cups-backends" { preferLocalBuild = true; } '' mkdir -p $out if [ ! -e ${cups.out}/lib/cups/backend/smb ]; then mkdir -p $out/lib/cups/backend ln -sv ${pkgs.samba}/bin/smbspool $out/lib/cups/backend/smb fi # Provide support for printing via HTTPS. if [ ! -e ${cups.out}/lib/cups/backend/https ]; then mkdir -p $out/lib/cups/backend ln -sv ${cups.out}/lib/cups/backend/ipp $out/lib/cups/backend/https fi ''; # 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 # we can't update ${cups.out}/lib/cups itself, we create a symlink tree # here and add the additional programs. The ServerBin directive in # cups-files.conf tells cupsd to use this tree. bindir = pkgs.buildEnv { name = "cups-progs"; paths = [ cups.out additionalBackends cups-filters pkgs.ghostscript ] ++ cfg.drivers; pathsToLink = [ "/lib" "/share/cups" "/bin" ]; postBuild = cfg.bindirCmds; ignoreCollisions = true; }; 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 DocumentRoot ${cups.out}/share/doc/cups AccessLog syslog ErrorLog syslog PageLog syslog TempDir ${cfg.tempDir} SetEnv PATH /var/lib/cups/path/lib/cups/filter:/var/lib/cups/path/bin # 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 /run/cups/cups.sock DefaultShared ${if cfg.defaultShared then "Yes" else "No"} Browsing ${if cfg.browsing then "Yes" else "No"} WebInterface ${if cfg.webInterface then "Yes" else "No"} LogLevel ${cfg.logLevel} ${cfg.extraConf} ''; browsedFile = writeConf "cups-browsed.conf" cfg.browsedConf; rootdir = pkgs.buildEnv { name = "cups-progs"; paths = [ cupsFilesFile cupsdFile (writeConf "client.conf" cfg.clientConf) (writeConf "snmp.conf" cfg.snmpConf) ] ++ optional avahiEnabled browsedFile ++ cfg.drivers; pathsToLink = [ "/etc/cups" ]; ignoreCollisions = true; }; filterGutenprint = filter (pkg: pkg.meta.isGutenprint or false == true); containsGutenprint = pkgs: length (filterGutenprint pkgs) > 0; getGutenprint = pkgs: head (filterGutenprint pkgs); in { imports = [ (mkChangedOptionModule [ "services" "printing" "gutenprint" ] [ "services" "printing" "drivers" ] (config: let enabled = getAttrFromPath [ "services" "printing" "gutenprint" ] config; in if enabled then [ pkgs.gutenprint ] else [ ])) (mkRemovedOptionModule [ "services" "printing" "cupsFilesConf" ] "") (mkRemovedOptionModule [ "services" "printing" "cupsdConf" ] "") ]; ###### interface options = { services.printing = { enable = mkOption { type = types.bool; default = false; description = lib.mdDoc '' Whether to enable printing support through the CUPS daemon. ''; }; stateless = mkOption { type = types.bool; default = false; description = lib.mdDoc '' If set, all state directories relating to CUPS will be removed on startup of the service. ''; }; startWhenNeeded = mkOption { type = types.bool; default = true; description = lib.mdDoc '' If set, CUPS is socket-activated; that is, instead of having it permanently running as a daemon, systemd will start it on the first incoming connection. ''; }; listenAddresses = mkOption { type = types.listOf types.str; default = [ "localhost:631" ]; example = [ "*:631" ]; description = lib.mdDoc '' A list of addresses and ports on which to listen. ''; }; allowFrom = mkOption { type = types.listOf types.str; default = [ "localhost" ]; example = [ "all" ]; apply = concatMapStringsSep "\n" (x: "Allow ${x}"); description = lib.mdDoc '' From which hosts to allow unconditional access. ''; }; bindirCmds = mkOption { type = types.lines; internal = true; default = ""; description = lib.mdDoc '' Additional commands executed while creating the directory containing the CUPS server binaries. ''; }; defaultShared = mkOption { type = types.bool; default = false; description = lib.mdDoc '' Specifies whether local printers are shared by default. ''; }; browsing = mkOption { type = types.bool; default = false; description = lib.mdDoc '' Specifies whether shared printers are advertised. ''; }; webInterface = mkOption { type = types.bool; default = true; description = lib.mdDoc '' Specifies whether the web interface is enabled. ''; }; logLevel = mkOption { type = types.str; default = "info"; example = "debug"; description = lib.mdDoc '' Specifies the cupsd logging verbosity. ''; }; extraFilesConf = mkOption { type = types.lines; default = ""; description = lib.mdDoc '' Extra contents of the configuration file of the CUPS daemon ({file}`cups-files.conf`). ''; }; extraConf = mkOption { type = types.lines; default = ""; example = '' BrowsePoll cups.example.com MaxCopies 42 ''; description = lib.mdDoc '' Extra contents of the configuration file of the CUPS daemon ({file}`cupsd.conf`). ''; }; clientConf = mkOption { type = types.lines; default = ""; example = '' ServerName server.example.com Encryption Never ''; description = lib.mdDoc '' The contents of the client configuration. ({file}`client.conf`) ''; }; browsedConf = mkOption { type = types.lines; default = ""; example = '' BrowsePoll cups.example.com ''; description = lib.mdDoc '' The contents of the configuration. file of the CUPS Browsed daemon ({file}`cups-browsed.conf`) ''; }; snmpConf = mkOption { type = types.lines; default = '' Address @LOCAL ''; description = lib.mdDoc '' The contents of {file}`/etc/cups/snmp.conf`. See "man cups-snmp.conf" for a complete description. ''; }; drivers = mkOption { type = types.listOf types.path; default = []; example = literalExpression "with pkgs; [ gutenprint hplip splix ]"; description = lib.mdDoc '' CUPS drivers to use. Drivers provided by CUPS, cups-filters, Ghostscript and Samba are added unconditionally. If this list contains Gutenprint (i.e. a derivation with `meta.isGutenprint = true`) the PPD files in {file}`/var/lib/cups/ppd` will be updated automatically to avoid errors due to incompatible versions. ''; }; tempDir = mkOption { type = types.path; default = "/tmp"; example = "/tmp/cups"; description = lib.mdDoc '' CUPSd temporary directory. ''; }; }; }; ###### implementation config = mkIf config.services.printing.enable { users.users.cups = { uid = config.ids.uids.cups; group = "lp"; description = "CUPS printing services"; }; environment.systemPackages = [ cups.out ] ++ optional polkitEnabled cups-pk-helper; environment.etc.cups.source = "/var/lib/cups"; services.dbus.packages = [ cups.out ] ++ optional polkitEnabled cups-pk-helper; # Allow asswordless printer admin for members of wheel group security.polkit.extraConfig = mkIf polkitEnabled '' polkit.addRule(function(action, subject) { if (action.id == "org.opensuse.cupspkhelper.mechanism.all-edit" && subject.isInGroup("wheel")){ return polkit.Result.YES; } }); ''; # Cups uses libusb to talk to printers, and does not use the # 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" ]; # Some programs like print-manager rely on this value to get # printer test pages. environment.sessionVariables.CUPS_DATADIR = "${bindir}/share/cups"; systemd.packages = [ cups.out ]; systemd.sockets.cups = mkIf cfg.startWhenNeeded { wantedBy = [ "sockets.target" ]; listenStreams = [ "/run/cups/cups.sock" ] ++ map (x: replaceStrings ["localhost"] ["127.0.0.1"] (removePrefix "*:" x)) cfg.listenAddresses; }; systemd.services.cups = { wantedBy = optionals (!cfg.startWhenNeeded) [ "multi-user.target" ]; wants = [ "network.target" ]; after = [ "network.target" ]; path = [ cups.out ]; preStart = lib.optionalString cfg.stateless '' rm -rf /var/cache/cups /var/lib/cups /var/spool/cups '' + '' mkdir -m 0700 -p /var/cache/cups mkdir -m 0700 -p /var/spool/cups mkdir -m 0755 -p ${cfg.tempDir} mkdir -m 0755 -p /var/lib/cups # While cups will automatically create self-signed certificates if accessed via TLS, # this directory to store the certificates needs to be created manually. mkdir -m 0700 -p /var/lib/cups/ssl # 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 #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 ${optionalString (containsGutenprint cfg.drivers) '' if [ -d /var/lib/cups/ppd ]; then ${getGutenprint cfg.drivers}/bin/cups-genppdupdate -p /var/lib/cups/ppd fi ''} ''; serviceConfig = { PrivateTmp = true; RuntimeDirectory = [ "cups" ]; }; }; systemd.services.cups-browsed = mkIf avahiEnabled { description = "CUPS Remote Printer Discovery"; wantedBy = [ "multi-user.target" ]; wants = [ "avahi-daemon.service" ] ++ optional (!cfg.startWhenNeeded) "cups.service"; bindsTo = [ "avahi-daemon.service" ] ++ optional (!cfg.startWhenNeeded) "cups.service"; partOf = [ "avahi-daemon.service" ] ++ optional (!cfg.startWhenNeeded) "cups.service"; after = [ "avahi-daemon.service" ] ++ optional (!cfg.startWhenNeeded) "cups.service"; path = [ cups ]; serviceConfig.ExecStart = "${cups-filters}/bin/cups-browsed"; restartTriggers = [ browsedFile ]; }; services.printing.extraConf = '' DefaultAuthType Basic Order allow,deny ${cfg.allowFrom} Order allow,deny ${cfg.allowFrom} AuthType Basic Require user @SYSTEM Order allow,deny ${cfg.allowFrom} Require user @OWNER @SYSTEM Order deny,allow AuthType Basic Require user @SYSTEM Order deny,allow Require user @OWNER @SYSTEM Order deny,allow Order deny,allow ''; security.pam.services.cups = {}; }; meta.maintainers = with lib.maintainers; [ matthewbauer ]; }