commit 49a129ab4027ceeee3d4f67898ff6ee8067daeac · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       1018
       1018
        
         ./services/networking/znc/default.nix

     

       1019
       1019
        
         ./services/printing/cupsd.nix

     

       1020
       1020
        
         ./services/printing/ipp-usb.nix

     

       1021
       1021
       +
         ./services/printing/cups-pdf.nix

     

       1021
       1022
        
         ./services/scheduling/atd.nix

     

       1022
       1023
        
         ./services/scheduling/cron.nix

     

       1023
       1024
        
         ./services/scheduling/fcron.nix

+185

nixos/modules/services/printing/cups-pdf.nix

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       let

     

       4
       4
       +
       

     

       5
       5
       +
         # cups calls its backends as user `lp` (which is good!),

     

       6
       6
       +
         # but cups-pdf wants to be called as `root`, so it can change ownership of files.

     

       7
       7
       +
         # We add a suid wrapper and a wrapper script to trick cups into calling the suid wrapper.

     

       8
       8
       +
         # Note that a symlink to the suid wrapper alone wouldn't suffice, cups would complain

     

       9
       9
       +
         # > File "/nix/store/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-cups-progs/lib/cups/backend/cups-pdf" has insecure permissions (0104554/uid=0/gid=20)

     

       10
       10
       +
       

     

       11
       11
       +
         # wrapper script that redirects calls to the suid wrapper

     

       12
       12
       +
         cups-pdf-wrapper = pkgs.writeTextFile {

     

       13
       13
       +
           name = "${pkgs.cups-pdf-to-pdf.name}-wrapper.sh";

     

       14
       14
       +
           executable = true;

     

       15
       15
       +
           destination = "/lib/cups/backend/cups-pdf";

     

       16
       16
       +
           checkPhase = ''

     

       17
       17
       +
             ${pkgs.stdenv.shellDryRun} "$target"

     

       18
       18
       +
             ${lib.getExe pkgs.shellcheck} "$target"

     

       19
       19
       +
           '';

     

       20
       20
       +
           text = ''

     

       21
       21
       +
             #! ${pkgs.runtimeShell}

     

       22
       22
       +
             exec "${config.security.wrapperDir}/cups-pdf" "$@"

     

       23
       23
       +
           '';

     

       24
       24
       +
         };

     

       25
       25
       +
       

     

       26
       26
       +
         # wrapped cups-pdf package that uses the suid wrapper

     

       27
       27
       +
         cups-pdf-wrapped = pkgs.buildEnv {

     

       28
       28
       +
           name = "${pkgs.cups-pdf-to-pdf.name}-wrapped";

     

       29
       29
       +
           # using the wrapper as first path ensures it is used

     

       30
       30
       +
           paths = [ cups-pdf-wrapper pkgs.cups-pdf-to-pdf ];

     

       31
       31
       +
           ignoreCollisions = true;

     

       32
       32
       +
         };

     

       33
       33
       +
       

     

       34
       34
       +
         instanceSettings = name: {

     

       35
       35
       +
           freeformType = with lib.types; nullOr (oneOf [ int str path package ]);

     

       36
       36
       +
           # override defaults:

     

       37
       37
       +
           # inject instance name into paths,

     

       38
       38
       +
           # also avoid conflicts between user names and special dirs

     

       39
       39
       +
           options.Out = lib.mkOption {

     

       40
       40
       +
             type = with lib.types; nullOr singleLineStr;

     

       41
       41
       +
             default = "/var/spool/cups-pdf-${name}/users/\${USER}";

     

       42
       42
       +
             defaultText = "/var/spool/cups-pdf-{instance-name}/users/\${USER}";

     

       43
       43
       +
             example = "\${HOME}/cups-pdf";

     

       44
       44
       +
             description = lib.mdDoc ''

     

       45
       45
       +
               output directory;

     

       46
       46
       +
               `''${HOME}` will be expanded to the user's home directory,

     

       47
       47
       +
               `''${USER}` will be expanded to the user name.

     

       48
       48
       +
             '';

     

       49
       49
       +
           };

     

       50
       50
       +
           options.AnonDirName = lib.mkOption {

     

       51
       51
       +
             type = with lib.types; nullOr singleLineStr;

     

       52
       52
       +
             default = "/var/spool/cups-pdf-${name}/anonymous";

     

       53
       53
       +
             defaultText = "/var/spool/cups-pdf-{instance-name}/anonymous";

     

       54
       54
       +
             example = "/var/lib/cups-pdf";

     

       55
       55
       +
             description = lib.mdDoc "path for anonymously created PDF files";

     

       56
       56
       +
           };

     

       57
       57
       +
           options.Spool = lib.mkOption {

     

       58
       58
       +
             type = with lib.types; nullOr singleLineStr;

     

       59
       59
       +
             default = "/var/spool/cups-pdf-${name}/spool";

     

       60
       60
       +
             defaultText = "/var/spool/cups-pdf-{instance-name}/spool";

     

       61
       61
       +
             example = "/var/lib/cups-pdf";

     

       62
       62
       +
             description = lib.mdDoc "spool directory";

     

       63
       63
       +
           };

     

       64
       64
       +
           options.Anonuser = lib.mkOption {

     

       65
       65
       +
             type = lib.types.singleLineStr;

     

       66
       66
       +
             default = "root";

     

       67
       67
       +
             description = lib.mdDoc ''

     

       68
       68
       +
               User for anonymous PDF creation.

     

       69
       69
       +
               An empty string disables this feature.

     

       70
       70
       +
             '';

     

       71
       71
       +
           };

     

       72
       72
       +
           options.GhostScript = lib.mkOption {

     

       73
       73
       +
             type = with lib.types; nullOr path;

     

       74
       74
       +
             default = lib.getExe pkgs.ghostscript;

     

       75
       75
       +
             defaultText = lib.literalExpression "lib.getExe pkgs.ghostscript";

     

       76
       76
       +
             example = lib.literalExpression ''''${pkgs.ghostscript}/bin/ps2pdf'';

     

       77
       77
       +
             description = lib.mdDoc "location of GhostScript binary";

     

       78
       78
       +
           };

     

       79
       79
       +
         };

     

       80
       80
       +
       

     

       81
       81
       +
         instanceConfig = { name, config, ... }: {

     

       82
       82
       +
           options = {

     

       83
       83
       +
             enable = (lib.mkEnableOption (lib.mdDoc "this cups-pdf instance")) // { default = true; };

     

       84
       84
       +
             installPrinter = (lib.mkEnableOption (lib.mdDoc ''

     

       85
       85
       +
               a CUPS printer queue for this instance.

     

       86
       86
       +
               The queue will be named after the instance and will use the {file}`CUPS-PDF_opt.ppd` ppd file.

     

       87
       87
       +
               If this is disabled, you need to add the queue yourself to use the instance

     

       88
       88
       +
             '')) // { default = true; };

     

       89
       89
       +
             confFileText = lib.mkOption {

     

       90
       90
       +
               type = lib.types.lines;

     

       91
       91
       +
               description = lib.mdDoc ''

     

       92
       92
       +
                 This will contain the contents of {file}`cups-pdf.conf` for this instance, derived from {option}`settings`.

     

       93
       93
       +
                 You can use this option to append text to the file.

     

       94
       94
       +
               '';

     

       95
       95
       +
             };

     

       96
       96
       +
             settings = lib.mkOption {

     

       97
       97
       +
               type = lib.types.submodule (instanceSettings name);

     

       98
       98
       +
               default = {};

     

       99
       99
       +
               example = {

     

       100
       100
       +
                 Out = "\${HOME}/cups-pdf";

     

       101
       101
       +
                 UserUMask = "0033";

     

       102
       102
       +
               };

     

       103
       103
       +
               description = lib.mdDoc ''

     

       104
       104
       +
                 Settings for a cups-pdf instance, see the descriptions in the template config file in the cups-pdf package.

     

       105
       105
       +
                 The key value pairs declared here will be translated into proper key value pairs for {file}`cups-pdf.conf`.

     

       106
       106
       +
                 Setting a value to `null` disables the option and removes it from the file.

     

       107
       107
       +
               '';

     

       108
       108
       +
             };

     

       109
       109
       +
           };

     

       110
       110
       +
           config.confFileText = lib.pipe config.settings [

     

       111
       111
       +
             (lib.filterAttrs (key: value: value != null))

     

       112
       112
       +
             (lib.mapAttrs (key: builtins.toString))

     

       113
       113
       +
             (lib.mapAttrsToList (key: value: "${key} ${value}\n"))

     

       114
       114
       +
             lib.concatStrings

     

       115
       115
       +
           ];

     

       116
       116
       +
         };

     

       117
       117
       +
       

     

       118
       118
       +
         cupsPdfCfg = config.services.printing.cups-pdf;

     

       119
       119
       +
       

     

       120
       120
       +
         copyConfigFileCmds = lib.pipe cupsPdfCfg.instances [

     

       121
       121
       +
           (lib.filterAttrs (name: lib.getAttr "enable"))

     

       122
       122
       +
           (lib.mapAttrs (name: lib.getAttr "confFileText"))

     

       123
       123
       +
           (lib.mapAttrs (name: pkgs.writeText "cups-pdf-${name}.conf"))

     

       124
       124
       +
           (lib.mapAttrsToList (name: confFile: "ln --symbolic --no-target-directory ${confFile} /var/lib/cups/cups-pdf-${name}.conf\n"))

     

       125
       125
       +
           lib.concatStrings

     

       126
       126
       +
         ];

     

       127
       127
       +
       

     

       128
       128
       +
         printerSettings = lib.pipe cupsPdfCfg.instances [

     

       129
       129
       +
           (lib.filterAttrs (name: lib.getAttr "enable"))

     

       130
       130
       +
           (lib.filterAttrs (name: lib.getAttr "installPrinter"))

     

       131
       131
       +
           (lib.mapAttrsToList (name: instance: (lib.mapAttrs (key: lib.mkDefault) {

     

       132
       132
       +
             inherit name;

     

       133
       133
       +
             model = "CUPS-PDF_opt.ppd";

     

       134
       134
       +
             deviceUri = "cups-pdf:/${name}";

     

       135
       135
       +
             description = "virtual printer for cups-pdf instance ${name}";

     

       136
       136
       +
             location = instance.settings.Out;

     

       137
       137
       +
           })))

     

       138
       138
       +
         ];

     

       139
       139
       +
       

     

       140
       140
       +
       in

     

       141
       141
       +
       

     

       142
       142
       +
       {

     

       143
       143
       +
       

     

       144
       144
       +
         options.services.printing.cups-pdf = {

     

       145
       145
       +
           enable = lib.mkEnableOption (lib.mdDoc ''

     

       146
       146
       +
             the cups-pdf virtual pdf printer backend.

     

       147
       147
       +
             By default, this will install a single printer `pdf`.

     

       148
       148
       +
             but this can be changed/extended with {option}`services.printing.cups-pdf.instances`

     

       149
       149
       +
           '');

     

       150
       150
       +
           instances = lib.mkOption {

     

       151
       151
       +
             type = lib.types.attrsOf (lib.types.submodule instanceConfig);

     

       152
       152
       +
             default.pdf = {};

     

       153
       153
       +
             example.pdf.settings = {

     

       154
       154
       +
               Out = "\${HOME}/cups-pdf";

     

       155
       155
       +
               UserUMask = "0033";

     

       156
       156
       +
             };

     

       157
       157
       +
             description = lib.mdDoc ''

     

       158
       158
       +
               Permits to raise one or more cups-pdf instances.

     

       159
       159
       +
               Each instance is named by an attribute name, and the attribute's values control the instance' configuration.

     

       160
       160
       +
             '';

     

       161
       161
       +
           };

     

       162
       162
       +
         };

     

       163
       163
       +
       

     

       164
       164
       +
         config = lib.mkIf cupsPdfCfg.enable {

     

       165
       165
       +
           services.printing.enable = true;

     

       166
       166
       +
           services.printing.drivers = [ cups-pdf-wrapped ];

     

       167
       167
       +
           hardware.printers.ensurePrinters = printerSettings;

     

       168
       168
       +
           # the cups module will install the default config file,

     

       169
       169
       +
           # but we don't need it and it would confuse cups-pdf

     

       170
       170
       +
           systemd.services.cups.preStart = lib.mkAfter ''

     

       171
       171
       +
             rm -f /var/lib/cups/cups-pdf.conf

     

       172
       172
       +
             ${copyConfigFileCmds}

     

       173
       173
       +
           '';

     

       174
       174
       +
           security.wrappers.cups-pdf = {

     

       175
       175
       +
             group = "lp";

     

       176
       176
       +
             owner = "root";

     

       177
       177
       +
             permissions = "+r,ug+x";

     

       178
       178
       +
             setuid = true;

     

       179
       179
       +
             source = "${pkgs.cups-pdf-to-pdf}/lib/cups/backend/cups-pdf";

     

       180
       180
       +
           };

     

       181
       181
       +
         };

     

       182
       182
       +
       

     

       183
       183
       +
         meta.maintainers = [ lib.maintainers.yarny ];

     

       184
       184
       +
       

     

       185
       185
       +
       }