commit cb506e6e2ed9133b43eb0c54699b8df4c9957cdf · pyrox.dev/nixpkgs

nixos/modules/module-list.nix

···

       260
       260
        
         ./services/logging/rsyslogd.nix

     

       261
       261
        
         ./services/logging/syslog-ng.nix

     

       262
       262
        
         ./services/logging/syslogd.nix

     

       263
       263
       +
         ./services/mail/clamsmtp.nix

     

       263
       264
        
         ./services/mail/dkimproxy-out.nix

     

       264
       265
        
         ./services/mail/dovecot.nix

     

       265
       266
        
         ./services/mail/dspam.nix

+179

nixos/modules/services/mail/clamsmtp.nix

···

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

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       let

     

       5
       5
       +
         cfg = config.services.clamsmtp;

     

       6
       6
       +
         clamdSocket = "/run/clamav/clamd.ctl"; # See services/security/clamav.nix

     

       7
       7
       +
       in

     

       8
       8
       +
       {

     

       9
       9
       +
         ##### interface

     

       10
       10
       +
         options = {

     

       11
       11
       +
           services.clamsmtp = {

     

       12
       12
       +
             enable = mkOption {

     

       13
       13
       +
               type = types.bool;

     

       14
       14
       +
               default = false;

     

       15
       15
       +
               description = "Whether to enable clamsmtp.";

     

       16
       16
       +
             };

     

       17
       17
       +
       

     

       18
       18
       +
             instances = mkOption {

     

       19
       19
       +
               description = "Instances of clamsmtp to run.";

     

       20
       20
       +
               type = types.listOf (types.submodule { options = {

     

       21
       21
       +
                 action = mkOption {

     

       22
       22
       +
                   type = types.enum [ "bounce" "drop" "pass" ];

     

       23
       23
       +
                   default = "drop";

     

       24
       24
       +
                   description =

     

       25
       25
       +
                     ''

     

       26
       26
       +
                       Action to take when a virus is detected.

     

       27
       27
       +
       

     

       28
       28
       +
                       Note that viruses often spoof sender addresses, so bouncing is

     

       29
       29
       +
                       in most cases not a good idea.

     

       30
       30
       +
                     '';

     

       31
       31
       +
                 };

     

       32
       32
       +
       

     

       33
       33
       +
                 header = mkOption {

     

       34
       34
       +
                   type = types.str;

     

       35
       35
       +
                   default = "";

     

       36
       36
       +
                   example = "X-Virus-Scanned: ClamAV using ClamSMTP";

     

       37
       37
       +
                   description =

     

       38
       38
       +
                     ''

     

       39
       39
       +
                       A header to add to scanned messages. See clamsmtpd.conf(5) for

     

       40
       40
       +
                       more details. Empty means no header.

     

       41
       41
       +
                     '';

     

       42
       42
       +
                 };

     

       43
       43
       +
       

     

       44
       44
       +
                 keepAlives = mkOption {

     

       45
       45
       +
                   type = types.int;

     

       46
       46
       +
                   default = 0;

     

       47
       47
       +
                   description =

     

       48
       48
       +
                     ''

     

       49
       49
       +
                       Number of seconds to wait between each NOOP sent to the sending

     

       50
       50
       +
                       server. 0 to disable.

     

       51
       51
       +
       

     

       52
       52
       +
                       This is meant for slow servers where the sending MTA times out

     

       53
       53
       +
                       waiting for clamd to scan the file.

     

       54
       54
       +
                     '';

     

       55
       55
       +
                 };

     

       56
       56
       +
       

     

       57
       57
       +
                 listen = mkOption {

     

       58
       58
       +
                   type = types.str;

     

       59
       59
       +
                   example = "127.0.0.1:10025";

     

       60
       60
       +
                   description =

     

       61
       61
       +
                     ''

     

       62
       62
       +
                       Address to wait for incoming SMTP connections on. See

     

       63
       63
       +
                       clamsmtpd.conf(5) for more details.

     

       64
       64
       +
                     '';

     

       65
       65
       +
                 };

     

       66
       66
       +
       

     

       67
       67
       +
                 quarantine = mkOption {

     

       68
       68
       +
                   type = types.bool;

     

       69
       69
       +
                   default = false;

     

       70
       70
       +
                   description =

     

       71
       71
       +
                     ''

     

       72
       72
       +
                       Whether to quarantine files that contain viruses by leaving them

     

       73
       73
       +
                       in the temporary directory.

     

       74
       74
       +
                     '';

     

       75
       75
       +
                 };

     

       76
       76
       +
       

     

       77
       77
       +
                 maxConnections = mkOption {

     

       78
       78
       +
                   type = types.int;

     

       79
       79
       +
                   default = 64;

     

       80
       80
       +
                   description = "Maximum number of connections to accept at once.";

     

       81
       81
       +
                 };

     

       82
       82
       +
       

     

       83
       83
       +
                 outAddress = mkOption {

     

       84
       84
       +
                   type = types.str;

     

       85
       85
       +
                   description =

     

       86
       86
       +
                     ''

     

       87
       87
       +
                       Address of the SMTP server to send email to once it has been

     

       88
       88
       +
                       scanned.

     

       89
       89
       +
                     '';

     

       90
       90
       +
                 };

     

       91
       91
       +
       

     

       92
       92
       +
                 tempDirectory = mkOption {

     

       93
       93
       +
                   type = types.str;

     

       94
       94
       +
                   default = "/tmp";

     

       95
       95
       +
                   description =

     

       96
       96
       +
                     ''

     

       97
       97
       +
                       Temporary directory that needs to be accessible to both clamd

     

       98
       98
       +
                       and clamsmtpd.

     

       99
       99
       +
                     '';

     

       100
       100
       +
                 };

     

       101
       101
       +
       

     

       102
       102
       +
                 timeout = mkOption {

     

       103
       103
       +
                   type = types.int;

     

       104
       104
       +
                   default = 180;

     

       105
       105
       +
                   description = "Time-out for network connections.";

     

       106
       106
       +
                 };

     

       107
       107
       +
       

     

       108
       108
       +
                 transparentProxy = mkOption {

     

       109
       109
       +
                   type = types.bool;

     

       110
       110
       +
                   default = false;

     

       111
       111
       +
                   description = "Enable clamsmtp's transparent proxy support.";

     

       112
       112
       +
                 };

     

       113
       113
       +
       

     

       114
       114
       +
                 virusAction = mkOption {

     

       115
       115
       +
                   type = with types; nullOr path;

     

       116
       116
       +
                   default = null;

     

       117
       117
       +
                   description =

     

       118
       118
       +
                     ''

     

       119
       119
       +
                       Command to run when a virus is found. Please see VIRUS ACTION in

     

       120
       120
       +
                       clamsmtpd(8) for a discussion of this option and its safe use.

     

       121
       121
       +
                     '';

     

       122
       122
       +
                 };

     

       123
       123
       +
       

     

       124
       124
       +
                 xClient = mkOption {

     

       125
       125
       +
                   type = types.bool;

     

       126
       126
       +
                   default = false;

     

       127
       127
       +
                   description =

     

       128
       128
       +
                     ''

     

       129
       129
       +
                       Send the XCLIENT command to the receiving server, for forwarding

     

       130
       130
       +
                       client addresses and connection information if the receiving

     

       131
       131
       +
                       server supports this feature.

     

       132
       132
       +
                     '';

     

       133
       133
       +
                 };

     

       134
       134
       +
               };});

     

       135
       135
       +
             };

     

       136
       136
       +
           };

     

       137
       137
       +
         };

     

       138
       138
       +
       

     

       139
       139
       +
         ##### implementation

     

       140
       140
       +
         config = let

     

       141
       141
       +
           configfile = conf: pkgs.writeText "clamsmtpd.conf"

     

       142
       142
       +
             ''

     

       143
       143
       +
               Action: ${conf.action}

     

       144
       144
       +
               ClamAddress: ${clamdSocket}

     

       145
       145
       +
               Header: ${conf.header}

     

       146
       146
       +
               KeepAlives: ${toString conf.keepAlives}

     

       147
       147
       +
               Listen: ${conf.listen}

     

       148
       148
       +
               Quarantine: ${if conf.quarantine then "on" else "off"}

     

       149
       149
       +
               MaxConnections: ${toString conf.maxConnections}

     

       150
       150
       +
               OutAddress: ${conf.outAddress}

     

       151
       151
       +
               TempDirectory: ${conf.tempDirectory}

     

       152
       152
       +
               TimeOut: ${toString conf.timeout}

     

       153
       153
       +
               TransparentProxy: ${if conf.transparentProxy then "on" else "off"}

     

       154
       154
       +
               User: clamav

     

       155
       155
       +
               ${optionalString (conf.virusAction != null) "VirusAction: ${conf.virusAction}"}

     

       156
       156
       +
               XClient: ${if conf.xClient then "on" else "off"}

     

       157
       157
       +
             '';

     

       158
       158
       +
         in

     

       159
       159
       +
           mkIf cfg.enable {

     

       160
       160
       +
             assertions = [

     

       161
       161
       +
               { assertion = config.services.clamav.daemon.enable;

     

       162
       162
       +
                 message = "clamsmtp requires clamav to be enabled";

     

       163
       163
       +
               }

     

       164
       164
       +
             ];

     

       165
       165
       +
       

     

       166
       166
       +
             systemd.services = listToAttrs (imap1 (i: conf:

     

       167
       167
       +
               nameValuePair "clamsmtp-${toString i}" {

     

       168
       168
       +
                 description = "ClamSMTP instance ${toString i}";

     

       169
       169
       +
                 wantedBy = [ "multi-user.target" ];

     

       170
       170
       +
                 script = "exec ${pkgs.clamsmtp}/bin/clamsmtpd -f ${configfile conf}";

     

       171
       171
       +
                 after = [ "clamav-daemon.service" ];

     

       172
       172
       +
                 requires = [ "clamav-daemon.service" ];

     

       173
       173
       +
                 serviceConfig.Type = "forking";

     

       174
       174
       +
                 serviceConfig.PrivateTmp = "yes";

     

       175
       175
       +
                 unitConfig.JoinsNamespaceOf = "clamav-daemon.service";

     

       176
       176
       +
               }

     

       177
       177
       +
             ) cfg.instances);

     

       178
       178
       +
           };

     

       179
       179
       +
       }