2e751c0772
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.
126 lines
3.6 KiB
Nix
126 lines
3.6 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.opensnitch;
|
|
format = pkgs.formats.json {};
|
|
in {
|
|
options = {
|
|
services.opensnitch = {
|
|
enable = mkEnableOption "Opensnitch application firewall";
|
|
settings = mkOption {
|
|
type = types.submodule {
|
|
freeformType = format.type;
|
|
|
|
options = {
|
|
Server = {
|
|
|
|
Address = mkOption {
|
|
type = types.str;
|
|
description = lib.mdDoc ''
|
|
Unix socket path (unix:///tmp/osui.sock, the "unix:///" part is
|
|
mandatory) or TCP socket (192.168.1.100:50051).
|
|
'';
|
|
};
|
|
|
|
LogFile = mkOption {
|
|
type = types.path;
|
|
description = lib.mdDoc ''
|
|
File to write logs to (use /dev/stdout to write logs to standard
|
|
output).
|
|
'';
|
|
};
|
|
|
|
};
|
|
|
|
DefaultAction = mkOption {
|
|
type = types.enum [ "allow" "deny" ];
|
|
description = lib.mdDoc ''
|
|
Default action whether to block or allow application internet
|
|
access.
|
|
'';
|
|
};
|
|
|
|
DefaultDuration = mkOption {
|
|
type = types.enum [
|
|
"once" "always" "until restart" "30s" "5m" "15m" "30m" "1h"
|
|
];
|
|
description = lib.mdDoc ''
|
|
Default duration of firewall rule.
|
|
'';
|
|
};
|
|
|
|
InterceptUnknown = mkOption {
|
|
type = types.bool;
|
|
description = lib.mdDoc ''
|
|
Wheter to intercept spare connections.
|
|
'';
|
|
};
|
|
|
|
ProcMonitorMethod = mkOption {
|
|
type = types.enum [ "ebpf" "proc" "ftrace" "audit" ];
|
|
description = lib.mdDoc ''
|
|
Which process monitoring method to use.
|
|
'';
|
|
};
|
|
|
|
LogLevel = mkOption {
|
|
type = types.enum [ 0 1 2 3 4 ];
|
|
description = lib.mdDoc ''
|
|
Default log level from 0 to 4 (debug, info, important, warning,
|
|
error).
|
|
'';
|
|
};
|
|
|
|
Firewall = mkOption {
|
|
type = types.enum [ "iptables" "nftables" ];
|
|
description = lib.mdDoc ''
|
|
Which firewall backend to use.
|
|
'';
|
|
};
|
|
|
|
Stats = {
|
|
|
|
MaxEvents = mkOption {
|
|
type = types.int;
|
|
description = lib.mdDoc ''
|
|
Max events to send to the GUI.
|
|
'';
|
|
};
|
|
|
|
MaxStats = mkOption {
|
|
type = types.int;
|
|
description = lib.mdDoc ''
|
|
Max stats per item to keep in backlog.
|
|
'';
|
|
};
|
|
|
|
};
|
|
};
|
|
};
|
|
description = lib.mdDoc ''
|
|
opensnitchd configuration. Refer to
|
|
<https://github.com/evilsocket/opensnitch/wiki/Configurations>
|
|
for details on supported values.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
# pkg.opensnitch is referred to elsewhere in the module so we don't need to worry about it being garbage collected
|
|
services.opensnitch.settings = mapAttrs (_: v: mkDefault v) (builtins.fromJSON (builtins.unsafeDiscardStringContext (builtins.readFile "${pkgs.opensnitch}/etc/default-config.json")));
|
|
|
|
systemd = {
|
|
packages = [ pkgs.opensnitch ];
|
|
services.opensnitchd.wantedBy = [ "multi-user.target" ];
|
|
};
|
|
|
|
environment.etc."opensnitchd/default-config.json".source = format.generate "default-config.json" cfg.settings;
|
|
|
|
};
|
|
}
|
|
|