nixos/go-csp-collector: init module

2025-10-27 10:37:24 +01:00
parent 9a4f7a19e4
commit e30ee35619
2 changed files with 107 additions and 0 deletions
@@ -990,6 +990,7 @@
  ./services/monitoring/gitwatch.nix
  ./services/monitoring/glances.nix
  ./services/monitoring/glpi-agent.nix
+  ./services/monitoring/go-csp-collector.nix
  ./services/monitoring/goss.nix
  ./services/monitoring/grafana-image-renderer.nix
  ./services/monitoring/grafana-reporter.nix
@@ -0,0 +1,106 @@
+{
+  config,
+  lib,
+  pkgs,
+  ...
+}:
+let
+  cfg = config.services.go-csp-collector;
+
+  inherit (lib)
+    boolToString
+    concatStringsSep
+    getExe
+    isBool
+    literalExpression
+    maintainers
+    mapAttrsToList
+    mkEnableOption
+    mkIf
+    mkOption
+    mkPackageOption
+    types
+    ;
+
+  settingsToArgs =
+    settings:
+    concatStringsSep " " (
+      mapAttrsToList (
+        name: value:
+        let
+          flag = "-${name}";
+        in
+        if isBool value then "${flag}=${boolToString value}" else "${flag} ${toString value}"
+      ) settings
+    );
+in
+{
+  meta.maintainers = with maintainers; [ stepbrobd ];
+
+  options.services.go-csp-collector = {
+    enable = mkEnableOption "go-csp-collector, a content security policy violation collector";
+
+    package = mkPackageOption pkgs "go-csp-collector" { };
+
+    settings = mkOption {
+      type = types.submodule {
+        freeformType =
+          with types;
+          attrsOf (oneOf [
+            bool
+            path
+            str
+          ]);
+
+        options = {
+          port = mkOption {
+            type = types.port;
+            description = "The port to listen on.";
+            default = 8080;
+            example = 8080;
+          };
+
+          output-format = mkOption {
+            type = types.enum [
+              "text"
+              "json"
+            ];
+            description = "Define how the violation reports are formatted for output.";
+            default = "text";
+            example = "text";
+          };
+        };
+      };
+
+      description = ''
+        Settings for go-csp-collector. See
+        <https://github.com/jacobbednarz/go-csp-collector> for supported options.
+      '';
+
+      default = { };
+
+      example = literalExpression ''
+        {
+          debug = true;
+          health-check-path = "/health";
+        }
+      '';
+    };
+  };
+
+  config = mkIf cfg.enable {
+    systemd.packages = [ cfg.package ];
+    systemd.services.go-csp-collector = {
+      description = "CSP violation collector";
+      wantedBy = [ "multi-user.target" ];
+      after = [ "network.target" ];
+      serviceConfig = {
+        ReadOnlyPaths = cfg.settings.filter-file or "";
+        ExecStart = [
+          ""
+          "${getExe cfg.package} ${settingsToArgs cfg.settings}"
+        ];
+      };
+    };
+  };
+}