the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
182 lines
5.7 KiB
Nix
182 lines
5.7 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
let
|
|
cfg = config.services.clamsmtp;
|
|
clamdSocket = "/run/clamav/clamd.ctl"; # See services/security/clamav.nix
|
|
in
|
|
{
|
|
##### interface
|
|
options = {
|
|
services.clamsmtp = {
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc "Whether to enable clamsmtp.";
|
|
};
|
|
|
|
instances = mkOption {
|
|
description = lib.mdDoc "Instances of clamsmtp to run.";
|
|
type = types.listOf (types.submodule { options = {
|
|
action = mkOption {
|
|
type = types.enum [ "bounce" "drop" "pass" ];
|
|
default = "drop";
|
|
description =
|
|
lib.mdDoc ''
|
|
Action to take when a virus is detected.
|
|
|
|
Note that viruses often spoof sender addresses, so bouncing is
|
|
in most cases not a good idea.
|
|
'';
|
|
};
|
|
|
|
header = mkOption {
|
|
type = types.str;
|
|
default = "";
|
|
example = "X-Virus-Scanned: ClamAV using ClamSMTP";
|
|
description =
|
|
lib.mdDoc ''
|
|
A header to add to scanned messages. See clamsmtpd.conf(5) for
|
|
more details. Empty means no header.
|
|
'';
|
|
};
|
|
|
|
keepAlives = mkOption {
|
|
type = types.int;
|
|
default = 0;
|
|
description =
|
|
lib.mdDoc ''
|
|
Number of seconds to wait between each NOOP sent to the sending
|
|
server. 0 to disable.
|
|
|
|
This is meant for slow servers where the sending MTA times out
|
|
waiting for clamd to scan the file.
|
|
'';
|
|
};
|
|
|
|
listen = mkOption {
|
|
type = types.str;
|
|
example = "127.0.0.1:10025";
|
|
description =
|
|
lib.mdDoc ''
|
|
Address to wait for incoming SMTP connections on. See
|
|
clamsmtpd.conf(5) for more details.
|
|
'';
|
|
};
|
|
|
|
quarantine = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description =
|
|
lib.mdDoc ''
|
|
Whether to quarantine files that contain viruses by leaving them
|
|
in the temporary directory.
|
|
'';
|
|
};
|
|
|
|
maxConnections = mkOption {
|
|
type = types.int;
|
|
default = 64;
|
|
description = lib.mdDoc "Maximum number of connections to accept at once.";
|
|
};
|
|
|
|
outAddress = mkOption {
|
|
type = types.str;
|
|
description =
|
|
lib.mdDoc ''
|
|
Address of the SMTP server to send email to once it has been
|
|
scanned.
|
|
'';
|
|
};
|
|
|
|
tempDirectory = mkOption {
|
|
type = types.str;
|
|
default = "/tmp";
|
|
description =
|
|
lib.mdDoc ''
|
|
Temporary directory that needs to be accessible to both clamd
|
|
and clamsmtpd.
|
|
'';
|
|
};
|
|
|
|
timeout = mkOption {
|
|
type = types.int;
|
|
default = 180;
|
|
description = lib.mdDoc "Time-out for network connections.";
|
|
};
|
|
|
|
transparentProxy = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc "Enable clamsmtp's transparent proxy support.";
|
|
};
|
|
|
|
virusAction = mkOption {
|
|
type = with types; nullOr path;
|
|
default = null;
|
|
description =
|
|
lib.mdDoc ''
|
|
Command to run when a virus is found. Please see VIRUS ACTION in
|
|
clamsmtpd(8) for a discussion of this option and its safe use.
|
|
'';
|
|
};
|
|
|
|
xClient = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description =
|
|
lib.mdDoc ''
|
|
Send the XCLIENT command to the receiving server, for forwarding
|
|
client addresses and connection information if the receiving
|
|
server supports this feature.
|
|
'';
|
|
};
|
|
};});
|
|
};
|
|
};
|
|
};
|
|
|
|
##### implementation
|
|
config = let
|
|
configfile = conf: pkgs.writeText "clamsmtpd.conf"
|
|
''
|
|
Action: ${conf.action}
|
|
ClamAddress: ${clamdSocket}
|
|
Header: ${conf.header}
|
|
KeepAlives: ${toString conf.keepAlives}
|
|
Listen: ${conf.listen}
|
|
Quarantine: ${if conf.quarantine then "on" else "off"}
|
|
MaxConnections: ${toString conf.maxConnections}
|
|
OutAddress: ${conf.outAddress}
|
|
TempDirectory: ${conf.tempDirectory}
|
|
TimeOut: ${toString conf.timeout}
|
|
TransparentProxy: ${if conf.transparentProxy then "on" else "off"}
|
|
User: clamav
|
|
${optionalString (conf.virusAction != null) "VirusAction: ${conf.virusAction}"}
|
|
XClient: ${if conf.xClient then "on" else "off"}
|
|
'';
|
|
in
|
|
mkIf cfg.enable {
|
|
assertions = [
|
|
{ assertion = config.services.clamav.daemon.enable;
|
|
message = "clamsmtp requires clamav to be enabled";
|
|
}
|
|
];
|
|
|
|
systemd.services = listToAttrs (imap1 (i: conf:
|
|
nameValuePair "clamsmtp-${toString i}" {
|
|
description = "ClamSMTP instance ${toString i}";
|
|
wantedBy = [ "multi-user.target" ];
|
|
script = "exec ${pkgs.clamsmtp}/bin/clamsmtpd -f ${configfile conf}";
|
|
after = [ "clamav-daemon.service" ];
|
|
requires = [ "clamav-daemon.service" ];
|
|
serviceConfig.Type = "forking";
|
|
serviceConfig.PrivateTmp = "yes";
|
|
unitConfig.JoinsNamespaceOf = "clamav-daemon.service";
|
|
}
|
|
) cfg.instances);
|
|
};
|
|
|
|
meta.maintainers = with lib.maintainers; [ ekleog ];
|
|
}
|